Class ansys::dpf::Model
Last update: 25.03.2026
Encapsulation of mesh and results.
Members
- CreateMeshQuery
- CreateResultEvaluationWorkflow
- CreateResultEvaluationWorkflow
- getMesh
- getMeshesContainer
- getResultInfo
- getTimeFreqSupport
- Model
- Model
- ReleaseHandles
- ~Model
Public functions
Function ~Model
virtual ansys::dpf::Model::~Model()
Return type:
Function Model
ansys::dpf::Model::Model(const std::string &filePath)
Create model from given file.
Parameters:
- const std::string & filePath: @ [in] File from which to create model.
Return type:
Function Model
ansys::dpf::Model::Model(const DataSources &data_sources)
Create model from given data sources.
Parameters:
- const DataSources & data_sources: [in] Data sources from which to create model.
Return type:
Function getMesh
MeshedRegion ansys::dpf::Model::getMesh(int timestep=0)
Returns:
Meshed region for given timestep.
Parameters:
- int timestep = 0 : [in] Optional timestep for which to get meshed region.
Return type: MeshedRegion
Function getMeshesContainer
MeshesContainer ansys::dpf::Model::getMeshesContainer()
Returns:
Meshes container for model.
Return type: MeshesContainer
Function getTimeFreqSupport
TimeFreqSupport ansys::dpf::Model::getTimeFreqSupport()
Retrieves the time/freq support to have access to the analysis domain (number times steps/frequences, correspending times/frequences/ harmonic indices, rpms) Returns:
Time frequency support for model.
Return type: TimeFreqSupport
Function getResultInfo
ResultInfo ansys::dpf::Model::getResultInfo()
Result Info allows to access to:
-
available results
-
unit
-
analysis type
-
physics type
Returns:
Result info for model.
Return type: ResultInfo
Function CreateResultEvaluationWorkflow
Result ansys::dpf::Model::CreateResultEvaluationWorkflow(const char *res_name, Scoping meshScoping=Scoping(), Location requested_location=Location(), int cs_id=0)
Returns:
Result for given result name.
Parameters:
- const char * res_name: [in] Result name for which to get Result.
- Scoping meshScoping = Scoping() : [in] Scoping of mesh elements or nodes.
- Location requested_location = Location() : [in] Location of evaluated result (nodal, elemental, or elemental_nodal).
- int cs_id = 0 : [in] Not used.
Return type: Result
Function CreateResultEvaluationWorkflow
Result ansys::dpf::Model::CreateResultEvaluationWorkflow(const char *res_name, const char *named_selection, Location requested_location=Location(), bool bInclusive=true, int cs_id=0)
Returns:
Result for given result name and named_selection of mesh.
Parameters:
- const char * res_name: [in] Result name for which to get Result.
- const char * named_selection: [in] Name of selected region in mesh. For MAPDL, names are capitalized.
- Location requested_location = Location() : [in] Location of evaluated result (nodal, elemental, or elemental_nodal).
- bool bInclusive = true : [in] When named_selection is a nodal region and requested_location is elemental, true indicates take elements with all nodes in region.
- int cs_id = 0 : If false, take elements with at least 1 node in region. [in] Not used.
Return type: Result
Function CreateMeshQuery
MeshQuery ansys::dpf::Model::CreateMeshQuery()
Returns:
Return type: MeshQuery
Function ReleaseHandles
void ansys::dpf::Model::ReleaseHandles()
Closes the files that were kept open to retrieve data.
Return type: void