ansys::CffFileProvider Class Reference
Last update: 24.03.2026Class that provides functions to access data stored within a CFF file. More...
#include "CffInterface/CffFileProvider.hpp"
Inheritance diagram for ansys::CffFileProvider:
Public Member Functions | |
| virtual | ~CffFileProvider () |
| Destructor. More... | |
| bool | startReading (const std::string &file, DataClass dataClass) |
| Start reading data of the class specified from the file passed in. More... | |
| bool | startReading (DataClass dataClass) override |
| Start reading data of the class from a filename that has been previously been associated with that data class. More... | |
| bool | endReading (DataClass dataClass) override |
| Stop reading data of the class from the filename that has been . previously opened with that data class. More... | |
| virtual bool | getDatasetNameOfPhase (PhaseIdType, std::string &) const |
| Unsupported - Do not use. More... | |
| virtual bool | getDatasetNameOfVariable (VariableIdType, std::string &) const |
| Unsupported - Do not use. More... | |
 Public Member Functions inherited from ansys::CffProvider | |
| CffProvider () | |
| Constructor. More... | |
| virtual | ~CffProvider () |
| Destructor. More... | |
| virtual void | setVariableTarget (const VariableTarget &target) |
| Sets the target variable naming convention. More... | |
| virtual void | setVariableRecipeProvider (CffVariableRecipeProvider *vrp) |
| Function allowing a user of the API to provide a Variable Recipe Provider that interprets data in a particular way. More... | |
| virtual void | setSkipReadZoneTopology (bool skip) |
| Set whether mesh zone to mesh zone topology topology should be constructed when the case data is read. It should be called prior to calling ansys::CffProvider::startReading. More... | |
| virtual void | setHeavyDataCacheMode (const DataCacheMode cacheMode) |
| Set whether heavy weight data is cached within the API when read from the database. This function should be called prior to ansys::CffProvider::startReading. More... | |
| virtual void | setReadAllSettings (bool readAllSettings) |
| Turn on whether settings are read into a Ansys Common Fluids Settings Data Model. More... | |
| virtual void | setKeyWordsForSettingsToBeRead (const std::vector< std::string > &dsNames, const std::vector< std::vector< std::string > > &settings) |
| Limit the key words to be read into a Ansys Common Fluids Settings Data Model. More... | |
| virtual void | getSettingsKeys (DataClass dataClass, std::vector< std::string > &keys) const |
| Return the keys that are available in the Physics Data Model. More... | |
| CffVariant | getSettings (const DataClass type, const std::string &key, const PhaseIdType phaseId=1) const |
| Return the value as a variable for a specific key in the Ansys Common Fluids Settings Data Model. More... | |
| virtual void | getSettingString (DataClass dataClass, const std::string &datasetName, std::string &contents, const std::string &path="") const |
| Read settings from a data set as text. More... | |
| virtual CffSetting | getSetting (const std::string &key="Common", DataClass dataClass=DataClass::CFF_CASE, const std::string &rootName=CffBase::_defaultSettingsPath) const |
| Read contents of a settings data set as a ansys::CffSetting object. More... | |
| virtual void | dump (std::string fileName="settings.xml") const |
| Dump all setting key/value pairs to a file. More... | |
| virtual void | print (bool objectOnly=true) const |
| Dump all setting key/value pairs to standard out. More... | |
| virtual bool | hasMeshId (MeshIdType) const |
| Determine whether a specific mesh exists. More... | |
| virtual MeshIds | availableMeshIds (DataClass dc=DataClass::CFF_CASE) const |
| Obtain the complete list of mesh Identifiers available. More... | |
| bool | hasTarget (TargetCategory target) const |
| Determine whether the any mesh can be read using the target category. More... | |
| TargetCategories | availableTargets () const |
| Obtain the complete list of targets available. More... | |
| virtual bool | hasTarget (MeshIdType, TargetCategory) const |
| Determine whether a specified mesh can be read using the target category. More... | |
| virtual TargetCategories | availableTargets (MeshIdType meshId, DataClass dc=DataClass::CFF_CASE) const |
| Obtain the complete list of targets available for a specific mesh identifier. More... | |
| bool | hasPartition (PartitionIdType) const |
| Query if the partition exists for any mesh. More... | |
| int | getPartitionCount () const |
| Query the global number of partitions available. More... | |
| PartitionIds | availablePartitionIds () const |
| Obtain the complete list of partitions available. More... | |
| virtual bool | hasPartition (MeshIdType, PartitionIdType) const |
| Query if the partition exists for specific mesh. More... | |
| virtual int | getPartitionCount (MeshIdType) const |
| Query the number of partitions available for a specific mesh. More... | |
| virtual PartitionIds | availablePartitionIds (MeshIdType meshId, DataClass dc=DataClass::CFF_CASE) const |
| Obtain the complete list of partitions available for a specific mesh identifier. More... | |
| virtual void | startReadingPartitionIdsForCells (ZoneIds &) const |
| virtual int | getPartitionCountForZone (const ZoneIdType zoneId) const |
| virtual PartitionIdType | getPartitionIdForCell (const ElemIdType cellId) const |
| virtual size_t | getPartitionIdsForCellsInRange (const ElemIdType, const ElemIdType, PartitionIdType *const partIds, const size_t) const |
| virtual size_t | getPartitionIdsForCellsInZone (const ZoneIdType, PartitionIdType *const partIds, const size_t) const |
| virtual void | endReadingPartitionIdsForCells () const |
| virtual void | startReadingCoordinatesForNodes (ZoneIds &zoneIds) const |
| Determine the node zones for which coordinates have been defined and prepare to read the coordinates for those zones. More... | |
| virtual size_t | getCoordinatesForNode (const ElemIdType nodeId, float *const coord, const size_t) const |
| Obtain the coordinates for a specific node. More... | |
| virtual size_t | getCoordinatesForNodesInRange (const ElemIdType minid, const ElemIdType maxId, float *const coords, const size_t) const |
| Obtain the coordinates for a node range. More... | |
| virtual size_t | getCoordinatesForNodesInZone (const ZoneIdType zoneId, float *const coords, const size_t) const |
| Obtain the coordinates for all nodes within a zone. More... | |
| virtual size_t | getCoordinatesForNode (const ElemIdType nodeId, double *const coord, const size_t) const |
| Obtain the coordinates for a specific node. More... | |
| virtual size_t | getCoordinatesForNodesInRange (const ElemIdType minid, const ElemIdType maxId, double *const coords, const size_t) const |
| Obtain the coordinates for a node range. More... | |
| virtual size_t | getCoordinatesForNodesInZone (const ZoneIdType zoneId, double *const coords, const size_t) const |
| Obtain the coordinates for all nodes within a zone. More... | |
| virtual void | endReadingCoordinatesForNodes () const |
| Finish reading coordinates for nodes. More... | |
| virtual void | startReadingNodesForEdges (ZoneIds &zoneIds) const |
| virtual void | startReadingNodeCountsForEdges () const |
| virtual bool | hasUniformNodeCountForEdgesInRange (const ElemIdType minId, const ElemIdType maxId, short *const uenc) const |
| virtual bool | hasUniformNodeCountForEdgesInZone (const ZoneIdType zoneId, short *const uenc) const |
| virtual short | getNodeCountForEdge (const ElemIdType edgeId) const |
| virtual size_t | getNodeCountsForEdgesInRange (const ElemIdType, const ElemIdType, short *const, const size_t) const |
| virtual size_t | getNodeCountsForEdgesInZone (const ZoneIdType zoneId, short *const fenc, const size_t) const |
| virtual void | endReadingNodeCountsForEdges () const |
| virtual void | startReadingNodeIdsForEdges () const |
| virtual size_t | getNodeIdsForEdge (const ElemIdType edgeId, ElemIdType *const enid, const size_t) const |
| virtual size_t | getNodeIdsForEdgesInRange (const ElemIdType, const ElemIdType, ElemIdType *const, const size_t) const |
| virtual size_t | getNodeIdsForEdgesInZone (const ZoneIdType, ElemIdType *const, const size_t) const |
| virtual void | endReadingNodeIdsForEdges () const |
| virtual void | endReadingNodesForEdges () const |
| virtual void | startReadingNodesForFaces (ZoneIds &zoneIds) const |
| Determine the face zones for which nodes have been defined and prepare to read the nodes for those zones. More... | |
| virtual void | startReadingNodeCountsForFaces () const |
| Start reading the face node counts. More... | |
| virtual bool | hasUniformNodeCountForFacesInRange (const ElemIdType minId, const ElemIdType maxId, short *const ufnc) const |
| Query whether all faces in the face range are defined using a uniform node count. i.e. are all the same type. More... | |
| virtual bool | hasUniformNodeCountForFacesInZone (const ZoneIdType zoneId, short *const ufnc) const |
| Query whether all faces in the face zone are defined using a uniform node count. i.e. are all the same type. More... | |
| virtual short | getNodeCountForFace (const ElemIdType faceId) const |
| Get the node count for a sepcific face. More... | |
| virtual size_t | getNodeCountsForFacesInRange (const ElemIdType, const ElemIdType, short *const, const size_t) const |
| Get the node counts for a range of faces. More... | |
| virtual size_t | getNodeCountsForFacesInZone (const ZoneIdType zoneId, short *const fnc, const size_t) const |
| Get the node counts for all faces within a face zone. More... | |
| virtual void | endReadingNodeCountsForFaces () const |
| Finish reading the face node counts. More... | |
| virtual void | startReadingNodeIdsForFaces () const |
| Start reading the face nodes. More... | |
| virtual size_t | getNodeIdsForFace (const ElemIdType faceId, ElemIdType *const fnid, const size_t) const |
| Get the node identifiers for a specific face. More... | |
| virtual size_t | getNodeIdsForFacesInRange (const ElemIdType, const ElemIdType, ElemIdType *const, const size_t) const |
| Get the node identifiers for a range of faces. More... | |
| virtual size_t | getNodeIdsForFacesInZone (const ZoneIdType, ElemIdType *const, const size_t) const |
| Get the node identifiers for a all faces within a face zone. More... | |
| virtual void | endReadingNodeIdsForFaces () const |
| Finish reading the node identifiers for faces. More... | |
| virtual void | endReadingNodesForFaces () const |
| Finish reading the face node data. More... | |
| virtual void | startReadingCell0sForFaces (ZoneIds &zoneIds) const |
| Start reading the cell 0 parents. More... | |
| virtual ElemIdType | getCell0ForFace (const ElemIdType faceId) const |
| Obtain cell 0 parent for specified face. More... | |
| virtual size_t | getCell0sForFacesInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const cell0Id, const size_t) const |
| Obtain cell 0 parents for all faces within a face range. More... | |
| virtual size_t | getCell0sForFacesInZone (const ZoneIdType zoneId, ElemIdType *const cell0Id, const size_t) const |
| Obtain cell 0 parents for all faces in zone. More... | |
| virtual void | endReadingCell0sForFaces () const |
| Finish reading the cell 0 parents. More... | |
| virtual void | startReadingCell1sForFaces (ZoneIds &zoneIds) const |
| Start reading the cell 1 parents. More... | |
| virtual ElemIdType | getCell1ForFace (const ElemIdType faceId) const |
| Obtain cell 1 parent for specified face. More... | |
| virtual size_t | getCell1sForFacesInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const cell1, const size_t) const |
| Obtain cell 1 parents for all faces within a range. More... | |
| virtual size_t | getCell1sForFacesInZone (const ZoneIdType zoneId, ElemIdType *const fc1, const size_t) const |
| Obtain cell 1 parents for all faces in zone. More... | |
| virtual void | endReadingCell1sForFaces () const |
| Finish reading the cell 1 parents. More... | |
| virtual void | startReadingShadowFaceIdsForFaces (ZoneIds &zoneIds) const |
| virtual ElemIdType | getShadowFaceIdForFace (const ElemIdType faceId) const |
| virtual size_t | getShadowFaceIdsForFacesInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const shadowFaces, const size_t) const |
| virtual size_t | getShadowFaceIdsForFacesInZone (const ZoneIdType zoneId, ElemIdType *const shadowFaces, const size_t) const |
| virtual void | endReadingShadowFaceIdsForFaces () const |
| virtual void | startReadingInterfaceDataForFaces (ZoneIds &, std::vector< int > &) const |
| virtual size_t | getInterfaceDataForFace (const ElemIdType, double *const, const size_t, double *const, const size_t, size_t *const pf0, size_t *const =NULL) const |
| virtual size_t | getInterfaceDataForFacesInZone (const ZoneIdType zoneId, double *const, const size_t, double *const, const size_t, size_t *const, const size_t, size_t *const =NULL, const size_t=0) const |
| virtual size_t | getInterfaceDataForFace (const ElemIdType, float *const, const size_t, float *const, const size_t, size_t *const pf0, size_t *const =NULL) const |
| virtual size_t | getInterfaceDataForFacesInZone (const ZoneIdType zoneId, float *const, const size_t, float *const, const size_t, size_t *const, const size_t, size_t *const =NULL, const size_t=0) const |
| virtual void | endReadingInterfaceDataForFaces () const |
| virtual void | startReadingChildFacesForFaces (ZoneIds &) const |
| virtual void | startReadingChildFaceCountsForFaces () const |
| virtual short | getChildFaceCountForFace (const ElemIdType faceId) const |
| virtual size_t | getChildFaceCountsForFacesInRange (const ElemIdType, const ElemIdType, short *const, const size_t) const |
| virtual size_t | getChildFaceCountsForFacesInZone (const ZoneIdType, short *const, const size_t) const |
| virtual void | endReadingChildFaceCountsForFaces () const |
| virtual void | startReadingChildFaceIdsForFaces () const |
| virtual size_t | getChildFaceIdsForFace (const ElemIdType faceId, ElemIdType *const fcid, const size_t) const |
| virtual size_t | getChildFaceIdsForFacesInRange (const ElemIdType, const ElemIdType, ElemIdType *const, const size_t) const |
| virtual size_t | getChildFaceIdsForFacesInZone (const ZoneIdType, ElemIdType *const, const size_t) const |
| virtual void | endReadingChildFaceIdsForFaces () const |
| virtual void | endReadingChildFacesForFaces () const |
| virtual void | startReadingTypesForCells (ZoneIds &) const |
| Determine the cell zones for which cell types have been defined and prepare to read the cell types for those zones. More... | |
| virtual bool | hasUniformTypeForCellsInZone (const ZoneIdType zoneId, CellType *const) const |
| Query whether all cells in the cell zone have the same cell type. More... | |
| virtual CellType | getTypeForCell (const ElemIdType cellId) const |
| Query the type for a cell. More... | |
| virtual size_t | getTypesForCellsInRange (const ElemIdType, const ElemIdType, CellType *const, const size_t) const |
| Obtain the types of all cells in a range. More... | |
| virtual size_t | getTypesForCellsInZone (const ZoneIdType, CellType *const, const size_t) const |
| Obtain the types of all cells in a cell zone. More... | |
| virtual void | endReadingTypesForCells () const |
| Finish reading the types of cells. More... | |
| virtual void | startReadingNodesForCells (ZoneIds &zoneIds) const |
| Determine the cell zones for which nodes have been defined and prepare to read the nodes for those zones. More... | |
| virtual void | startReadingNodeCountsForCells () const |
| Start reading the cell node counts. More... | |
| virtual bool | hasUniformNodeCountForCellsInZone (const ZoneIdType zoneId, short *const ucnc) const |
| Query whether all cells in the cell zone are defined using a uniform node count. More... | |
| virtual short | getNodeCountForCell (const ElemIdType cellId) const |
| Get the node count for a sepcific cell. More... | |
| virtual size_t | getNodeCountsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, short *const cnc, const size_t) const |
| Get the node counts for a range of cells. More... | |
| virtual size_t | getNodeCountsForCellsInZone (const ZoneIdType zoneId, short *const cnc, const size_t) const |
| Get the node counts for all cells within a cell zone. More... | |
| virtual void | endReadingNodeCountsForCells () const |
| Finish reading the cell node counts. More... | |
| virtual void | startReadingNodeIdsForCells () const |
| Start reading the node identifiers for cells. More... | |
| virtual size_t | getNodeIdsForCell (const ElemIdType cellId, ElemIdType *const cnid, const size_t) const |
| Get the node identifiers for a specific cell. More... | |
| virtual size_t | getNodeIdsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const cnid, const size_t) const |
| Get the node identifiers for a range of cells. More... | |
| virtual size_t | getNodeIdsForCellsInZone (const ZoneIdType zoneId, ElemIdType *const cnid, const size_t) const |
| Get the node identifiers for all cells within a cell zone. More... | |
| virtual void | endReadingNodeIdsForCells () const |
| Finish reading the node identifiers for cells. More... | |
| virtual void | endReadingNodesForCells () const |
| Finish reading the cell node. More... | |
| virtual void | startReadingFacesForCells (ZoneIds &zoneIds) const |
| virtual void | startReadingFaceCountsForCells () const |
| virtual bool | hasUniformFaceCountForCellsInZone (const ZoneIdType zoneId, short *const ucfc) const |
| virtual short | getFaceCountForCell (const ElemIdType cellId) const |
| virtual size_t | getFaceCountsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, short *const cfc, const size_t dataSize) const |
| virtual size_t | getFaceCountsForCellsInZone (const ZoneIdType zoneId, short *const cfc, const size_t) const |
| virtual void | endReadingFaceCountsForCells () const |
| virtual void | startReadingFaceIdsForCells () const |
| virtual size_t | getFaceIdsForCell (const ElemIdType cellId, ElemIdType *const cfid, const size_t dataSize) const |
| virtual size_t | getFaceIdsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const cfid, const size_t dataSize) const |
| virtual size_t | getFaceIdsForCellsInZone (const ZoneIdType zoneId, ElemIdType *const cfid, const size_t) const |
| virtual void | endReadingFaceIdsForCells () const |
| virtual void | endReadingFacesForCells () const |
| virtual void | startReadingChildCellsForCells (ZoneIds &) const |
| virtual void | startReadingChildCellCountsForCells () const |
| virtual short | getChildCellCountForCell (const ElemIdType cellId) const |
| virtual size_t | getChildCellCountsForCellsInRange (const ElemIdType, const ElemIdType, short *const, const size_t) const |
| virtual size_t | getChildCellCountsForCellsInZone (const ZoneIdType, short *const, const size_t) const |
| virtual void | endReadingChildCellCountsForCells () const |
| virtual void | startReadingChildCellIdsForCells () const |
| virtual size_t | getChildCellIdsForCell (const ElemIdType cellId, ElemIdType *const ccid, const size_t) const |
| virtual size_t | getChildCellIdsForCellsInRange (const ElemIdType, const ElemIdType, ElemIdType *const, const size_t) const |
| virtual size_t | getChildCellIdsForCellsInZone (const ZoneIdType, ElemIdType *const, const size_t) const |
| virtual void | endReadingChildCellIdsForCells () const |
| virtual void | endReadingChildCellsForCells () const |
| virtual void | startReadingCategorizedCaseSections (const ZoneCategory, CategoryNames &categories) const |
| virtual PlainDataType | startReadingCaseSectionForCategory (const CategoryName &catgeory, ZoneIds &zoneIds) const |
| virtual void | startReadingCaseSectionDataCounts () const |
| virtual bool | hasUniformCaseSectionDataCountForZone (const ZoneIdType zoneId, short *const dc) const |
| virtual short | getCaseSectionDataCountForElement (const ElemIdType elemId) const |
| virtual size_t | getCaseSectionDataCountsForElementsInRange (const ElemIdType minId, const ElemIdType maxId, short *const dc, const size_t) const |
| virtual size_t | getCaseSectionDataCountsForElementsInZone (const ZoneIdType zoneId, short *const dc, const size_t) const |
| virtual void | endReadingCaseSectionDataCounts () const |
| virtual void | startReadingCaseSectionData () const |
| virtual size_t | getCaseSectionDataForElement (const ElemIdType elemId, void *const data, const size_t) const |
| virtual size_t | getCaseSectionDataForElementsInRange (const ElemIdType minId, const ElemIdType maxId, void *const data, const size_t) const |
| virtual size_t | getCaseSectionDataForElementsInZone (const ZoneIdType zoneId, void *const data, const size_t) const |
| virtual void | endReadingCaseSectionData () const |
| virtual void | endReadingCategorizedCaseSections () const |
| bool | isReadingData () const |
| DEPRECATED: Function to determine whether it is possible to read data of type ansys::DataClass::CFF_RESULTS. More... | |
| void | startReadingTimeLevel (const TimeLevelType=CffFinalTimeLevel) const |
| void | endReadingTimeLevel () const |
| virtual void | startReadingPhase (const PhaseIdType=1) const |
| virtual bool | getAttributesOfPhase (PhaseIdType, AttributeNames &) const |
| virtual bool | getAttributeValueOfPhase (PhaseIdType, const AttributeName &, AttributeValue &) const |
| virtual bool | getAttributesOfPhase (AttributeNames &) const |
| virtual bool | getAttributeValueOfPhase (const AttributeName &, AttributeValue &) const |
| virtual bool | getAttributesOfPhase (const PhaseName &, AttributeNames &) const |
| virtual bool | getAttributeValueOfPhase (const PhaseName &, const AttributeName &, AttributeValue &) const |
| virtual void | endReadingPhase () const |
| virtual size_t | getPhaseVariableCountOfCategory (const ZoneCategory) const |
| virtual void | getPhaseVariablesOfCategory (const ZoneCategory, VariableIds &) const |
| virtual void | getPhaseVariablesOfCategory (const ZoneCategory, VariableNames &) const |
| bool | getVariableId (PhaseIdType phaseId, const VariableName &varName, VariableIdType &varId) const |
| bool | getVariableId (const VariableName &varName, VariableIdType &varId) const |
| bool | getVariableId (const PhaseName &phaseName, const VariableName &varName, VariableIdType &varId) const |
| virtual size_t | startReadingZonesOfCategoryWithPhaseVariable (const ZoneCategory zoneCategory, const VariableIdType varId, ZoneIds &zoneIds) const |
| Determine the zones in which the phase variable exists, and if valid prepare to read the solution data for the variable in those zones. More... | |
| virtual size_t | startReadingZonesOfCategoryWithPhaseVariable (const ZoneCategory zoneCategory, const VariableName &varName, ZoneIds &zoneIds) const |
| Determine the zones in which the phase variable exists, and if valid prepare to read the solution data for the variable in those zones. More... | |
| virtual size_t | getValuesOfPhaseVariableForElement (const ElemIdType elemId, double *const vals, const size_t) const |
| Read solution data for a single element within a zone that contains the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More... | |
| virtual size_t | getValuesOfPhaseVariableForElementsInRange (const ElemIdType minId, const ElemIdType maxId, double *const vals, const size_t) const |
| Read solution data for a range of elements for the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More... | |
| virtual size_t | getValuesOfPhaseVariableForElementsInZone (const ZoneIdType zoneId, double *const vals, const size_t) const |
| Read solution data for a zone variable for all elements within a zone requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More... | |
| virtual size_t | getValuesOfPhaseVariableForElement (const ElemIdType elemId, float *const vals, const size_t) const |
| Read solution data for a single element within a zone that contains the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More... | |
| virtual size_t | getValuesOfPhaseVariableForElementsInRange (const ElemIdType minId, const ElemIdType maxId, float *const vals, const size_t) const |
| Read solution data for a range of elements for the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More... | |
| virtual size_t | getValuesOfPhaseVariableForElementsInZone (const ZoneIdType zoneId, float *const vals, const size_t) const |
| Read solution data for a zone variable for all elements within a zone requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More... | |
| virtual void | endReadingZonesOfCategoryWithPhaseVariable () const |
| End reading solution data for a zone variable previously started by a call to startReadingZonesOfCategoryWithPhaseVariable. More... | |
| virtual bool | hasParticles () const |
| virtual bool | hasParticles (const PhaseName &phaseName) const |
| virtual bool | hasParticles (const PhaseIdType phaseId) const |
| virtual bool | startReadingParticles () const |
| virtual bool | startReadingParticles (const PhaseName &phaseName) const |
| virtual bool | startReadingParticles (const PhaseIdType phaseId) const |
| virtual bool | hasParticleTracks () |
| Check if there are any particle tracks. More... | |
| virtual bool | hasParticleTracks (const MeshIdType meshId, const TargetCategory target=TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN, const PartitionIdType partition=-1) |
| Check whether particular particle tracks exist. More... | |
| virtual bool | hasParticleTracks (const PhaseIdType phaseId, const MeshIdType meshId, const TargetCategory target=TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN, const PartitionIdType partition=-1) |
| Check whether partucular particle tracks exist. More... | |
| virtual bool | hasParticleTracksInActivePhase () |
| Check if there are particle track data in active phase of active mesh set. More... | |
| virtual void | getMeshBranchesWithParticleTracks (MeshIds &mids, TargetCategories &tgts, PartitionIds &pids) |
| Get all mesh branches that contain particle track data, each mesh branch is specified by a pair of three values: meshId, target and partition (only applicable to the situation that target is PARTITION_POST) More... | |
| virtual std::vector< PhaseIdType > | getPhasesWithParticleTracks (const MeshIdType meshId=-1, const TargetCategory target=TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN, const PartitionIdType partition=-1) |
| Get all phases that contain particle track data in mesh specified by mesh, target and partition. More... | |
| virtual void | startReadingParticleTracks (const PhaseIdType phaseId=-1, const MeshIdType meshId=-1, const TargetCategory target=TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN, const PartitionIdType partition=-1) |
| Start reading particle tracks by phase in the mesh, target and partition. More... | |
| virtual void | getVariablesOfParticleTrack (std::vector< VariableName > &varNames, std::vector< bool > &isConst, std::vector< PlainDataType > &datTypes) |
| Get all variables in the particle track group. More... | |
| virtual void | getParticleTrackGroups (std::vector< std::string > &groupNames) |
| Get names of all particle track groups in current path. More... | |
| virtual size_t | startReadingParticleTrackGroup (const std::string &groupName) |
| Start reading a specific particle track group. More... | |
| virtual void | getChunksInParticleTrackGroup (std::vector< size_t > &chunks) |
| Get all chunk indices within the active particle track group. More... | |
| virtual size_t | startReadingChunkInParticleTrackGroup (const size_t chunkIndex=0) |
| Start reading the specified chunk within the particle track group. More... | |
| virtual size_t | startReadingVariableOfParticleTracksInChunk (const VariableName &varName) |
| Start reading variable in the current chunk. More... | |
| virtual void | getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, unsigned char *const data, const size_t dataSize) |
| Get data for the variable within the specified particle within the active chunk. More... | |
| virtual void | getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, char *const data, const size_t dataSize) |
| Get data for the variable within the specified particle within the active chunk. More... | |
| virtual void | getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, short *const data, const size_t dataSize) |
| Get data for the variable within the specified particle within the active chunk. More... | |
| virtual void | getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, unsigned int *const data, const size_t dataSize) |
| Get data for the variable within the specified particle within the active chunk. More... | |
| virtual void | getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, int *const data, const size_t dataSize) |
| Get data for the variable within the specified particle within the active chunk. More... | |
| virtual void | getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, long *const data, const size_t dataSize) |
| Get data for the variable within the specified particle within the active chunk. More... | |
| virtual void | getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, long long *const data, const size_t dataSize) |
| Get data for the variable within the specified particle within the active chunk. More... | |
| virtual void | getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, float *const data, const size_t dataSize) |
| Get data for the variable within the specified particle within the active chunk. More... | |
| virtual void | getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, double *const data, const size_t dataSize) |
| Get data for the variable within the specified particle within the active chunk. More... | |
| virtual void | getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, size_t *const data, const size_t dataSize) |
| Get data for the variable within the specified particle within the active chunk. More... | |
| virtual void | getVariableDataOfAllParticleTracksInChunk (unsigned char *const data, const size_t dataSize) |
| Get data for the variable in all particle tracks in the chunk. More... | |
| virtual void | getVariableDataOfAllParticleTracksInChunk (char *const data, const size_t dataSize) |
| Get data for the variable in all particle tracks in the chunk. More... | |
| virtual void | getVariableDataOfAllParticleTracksInChunk (short *const data, const size_t dataSize) |
| Get data for the variable in all particle tracks in the chunk. More... | |
| virtual void | getVariableDataOfAllParticleTracksInChunk (unsigned int *const data, const size_t dataSize) |
| Get data for the variable in all particle tracks in the chunk. More... | |
| virtual void | getVariableDataOfAllParticleTracksInChunk (int *const data, const size_t dataSize) |
| Get data for the variable in all particle tracks in the chunk. More... | |
| virtual void | getVariableDataOfAllParticleTracksInChunk (long *const data, const size_t dataSize) |
| Get data for the variable in all particle tracks in the chunk. More... | |
| virtual void | getVariableDataOfAllParticleTracksInChunk (long long *const data, const size_t dataSize) |
| Get data for the variable in all particle tracks in the chunk. More... | |
| virtual void | getVariableDataOfAllParticleTracksInChunk (float *const data, const size_t dataSize) |
| Get data for the variable in all particle tracks in the chunk. More... | |
| virtual void | getVariableDataOfAllParticleTracksInChunk (double *const data, const size_t dataSize) |
| Get data for the variable in all particle tracks in the chunk. More... | |
| virtual void | getVariableDataOfAllParticleTracksInChunk (size_t *const data, const size_t dataSize) |
| Get data for the variable in all particle tracks in the chunk. More... | |
| virtual void | endReadingVariableOfParticleTracksInChunk () |
| End reading variables in chunk. More... | |
| virtual void | endReadingChunkOfParticleTrackGroup () |
| End reading chunk in particle track group. More... | |
| virtual void | endReadingParticleTrackGroup () |
| End reading particle track group. More... | |
| virtual void | endReadingParticleTracks () |
| End reading particle tracks. More... | |
| virtual bool | isReading (DataClass dataClass) const |
| Return whether a reading of the class of data specified is possible. More... | |
| virtual bool | getAttributesOfPhaseVariable (VariableIdType, AttributeNames &) const |
| virtual bool | getAttributeValueOfPhaseVariable (VariableIdType, const AttributeName &, AttributeValue &) const |
| virtual bool | getAttributesOfPhaseVariable (const VariableName &, AttributeNames &) const |
| virtual bool | getAttributeValueOfPhaseVariable (const VariableName &, const AttributeName &, AttributeValue &) const |
| virtual bool | getAttributesOfPhaseVariable (PhaseIdType phaseId, const VariableName &, AttributeNames &) const |
| virtual bool | getAttributeValueOfPhaseVariable (PhaseIdType, const VariableName &, const AttributeName &, AttributeValue &) const |
| virtual bool | getAttributesOfPhaseVariable (const PhaseName &phaseName, const VariableName &, AttributeNames &) const |
| virtual bool | getAttributeValueOfPhaseVariable (const PhaseName &, const VariableName &, const AttributeName &, AttributeValue &) const |
| virtual void | getInjectionNames (InjectionNames &) const |
| virtual void | getVariablesOfInjection (const InjectionName &name, VariableNames &varNames) const |
| virtual void | getVariablesOfInjection (const InjectionName &name, VariableIds &varIds) const |
| virtual size_t | getNumOfParticlesInInjection (const InjectionName &name) const |
| virtual size_t | startReadingVariableForParticlesInInjection (const InjectionName &injName, const VariableName &varName, PlainDataType &dataType) const |
| virtual size_t | getValuesOfVariableForParticlesInInjection (double *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfVariableForParticlesInInjection (float *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfVariableForParticlesInInjection (ElemIdType *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfVariableForParticlesInInjection (int *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfVariableForParticlesInInjection (short *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfVariableForParticlesInInjection (unsigned int *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfVariableForParticlesInInjection (long *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfVariableForParticlesInInjection (long long *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfVariableForParticlesInInjection (char *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfVariableForParticlesInInjection (unsigned char *const vals, size_t const dataSize) const |
| virtual void | endReadingVariableForParticlesInInjection () const |
| virtual void | endReadingParticles () const |
| virtual bool | getSetNames (std::vector< std::string > &setNames) const |
| virtual bool | getSetNames (const DataClass dataClass, std::vector< std::string > &setNames) const |
| virtual bool | getSetNames (const DataClass dataClass, const ZoneCategory cat, std::vector< std::string > &setNames) const |
| virtual bool | startReadingSet (const DataClass dataClass, const ZoneCategory cat, const std::string &setName) |
| virtual void | startReadingIdsForSet (std::vector< size_t > &nElems, std::vector< ElemIdType > &minId, std::vector< ElemIdType > &maxId) |
| virtual size_t | getIdsForSetInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const setId, const size_t dataSize) |
| virtual void | endReadingIdsForSet () const |
| virtual void | getVariablesInSet (VariableNames &varNames, std::vector< bool > &hasSize) const |
| virtual void | startReadingVariableLengthedVarForSet (const VariableName &varName, PlainDataType &dataType) |
| virtual PlainDataType | startReadingSizeOfVariableLengthedVarForSet () const |
| virtual size_t | getSizeOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, CountType *const counts, size_t const dataSize) const |
| virtual size_t | getSizeOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, int *const counts, size_t const dataSize) const |
| virtual size_t | getSizeOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, size_t *const counts, size_t const dataSize) const |
| virtual void | endReadingSizeOfVariableLengthedVarForSet () const |
| virtual void | startReadingDataOfVariableLengthedVarForSet () const |
| virtual size_t | getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, unsigned char *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const |
| virtual size_t | getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, char *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const |
| virtual size_t | getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, short *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const |
| virtual size_t | getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, unsigned int *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const |
| virtual size_t | getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, int *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const |
| virtual size_t | getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, long *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const |
| virtual size_t | getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, long long *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const |
| virtual size_t | getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, float *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const |
| virtual size_t | getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, double *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const |
| virtual size_t | getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, size_t *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const |
| virtual void | endReadingDataOfVariableLengthedVarForSet () const |
| virtual void | endReadingVariableLengthedVarForSet () const |
| virtual size_t | startReadingConstantLengthedVarForSet (const VariableName &varName, PlainDataType &dataType) const |
| virtual size_t | getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, unsigned char *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, char *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, short *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, unsigned int *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, int *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, long *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, long long *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, float *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, double *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, size_t *const vals, size_t const dataSize) const |
| virtual void | endReadingConstantLengthedVarForSet () const |
| virtual void | getOtherVariablesInSet (VariableNames &varNames) const |
| virtual size_t | startReadingOtherVariableForSet (const VariableName &varName, PlainDataType &dataType, size_t &numElems) const |
| virtual size_t | getValuesOfOtherVariableForSet (unsigned char *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfOtherVariableForSet (char *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfOtherVariableForSet (short *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfOtherVariableForSet (unsigned int *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfOtherVariableForSet (int *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfOtherVariableForSet (long *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfOtherVariableForSet (long long *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfOtherVariableForSet (float *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfOtherVariableForSet (double *const vals, size_t const dataSize) const |
| virtual size_t | getValuesOfOtherVariableForSet (size_t *const vals, size_t const dataSize) const |
| virtual void | endReadingOtherVariableForSet () const |
| virtual void | endReadingSet () |
| virtual bool | startReadingSetData (const DataClass dataClass, const ZoneCategory cat, const std::string &setName) |
| virtual size_t | startReadingIdsForSetData () |
| virtual size_t | getNumRowsOfSetData (const int nth) const |
| virtual bool | getIdsForSetData (const int nth, ElemIdType *const setId, const size_t dataSize) const |
| virtual void | endReadingIdsForSetData () const |
| virtual void | getVariablesInSetData (VariableNames &varNames, std::vector< bool > &hasSize) const |
| virtual void | startReadingVariableLengthVarForSetData (const VariableName &varName) |
| virtual PlainDataType | getDataTypeOfDataForSetData () const |
| virtual PlainDataType | getDataTypeOfSizeForSetData () const |
| virtual size_t | startReadingSizeOfVariableLengthVarForSetData () const |
| virtual bool | getSizeOfVariableLengthVarForSetData (const int nth, void *const counts, size_t const dataSize) const |
| virtual void | endReadingSizeOfVariableLengthVarForSetData () const |
| virtual size_t | startReadingDataOfVariableLengthVarForSetData () const |
| virtual bool | getDataOfVariableLengthVarForSetData (const int nth, void *const vals, size_t const dataSize) const |
| virtual void | endReadingDataOfVariableLengthVarForSetData () const |
| virtual void | endReadingVariableLengthVarForSetData () const |
| virtual size_t | startReadingConstantLengthVarForSetData (const VariableName &varName) const |
| virtual size_t | getColumnsNumOfConstantLengthVarForSetData (const size_t nth) const |
| virtual bool | getDataOfConstantLengthVarForSetData (const int nth, void *const vals, size_t const dataSize) const |
| virtual void | endReadingConstantLengthVarForSetData () const |
| virtual void | getOtherVariablesInSetData (VariableNames &varNames) const |
| virtual size_t | startReadingOtherDataForSetData (const VariableName &varName, PlainDataType &dataType, size_t &numElems) const |
| virtual bool | getOtherDataForSetData (void *const vals, size_t const dataSize) const |
| virtual void | endReadingOtherDataForSetData () const |
| virtual void | endReadingSetData () |
| Public Member Functions inherited from ansys::CffBase | |
| CffBase () | |
| Constructor. More... | |
| virtual | ~CffBase () |
| Destructor. More... | |
| void | setPartitionId (const PartitionIdType pId) |
| PartitionIdType | getPartitionId () const |
| virtual void | setDebugOn (bool debug) |
| Turn on/off debugging information. More... | |
| virtual void | setReadNCIOn (bool readNCI) |
| Turn on/off non-conformal interface reading. More... | |
| void | setMeshId (const MeshIdType meshId) |
| Set the Identifier for active mesh being read or written. More... | |
| MeshIdType | getMeshId () const |
| Get the Identifier of the active mesh. More... | |
| void | setTarget (const TargetCategory target) |
| Set the target category for which the data is intended. More... | |
| TargetCategory | getTarget () const |
| Get the target category for which the data is intended. More... | |
| void | setMeshSize (const MeshSizeType type, const ElemIdType size) |
| Sets a value that defines the dimension or the global number of objects of a specific mesh entity. More... | |
| void | getMeshSize (const MeshSizeType type, ElemIdType &size) const |
| Obtains a value that defines the dimension or the global number of objects of a specific mesh entity. More... | |
| void | setMeshUnits (const std::string &units="m") |
| Define the units of length the mesh is defined in. More... | |
| void | getMeshUnits (std::string &unit) const |
| Obtains the unit of length the mesh is defined in. More... | |
| void | setZoneIds (const ZoneCategory zoneCategory, const ZoneIds &zonesIds) |
| Define the zones that are of a specific category. More... | |
| virtual size_t | getNumZones (const ZoneCategory) const |
| Returns the number of zones in a specific category. More... | |
| virtual void | getZoneIds (const ZoneCategory zoneCategory, ZoneIds &zoneIds) const |
| Request the collection of zone Ids that are of a specific category. More... | |
| void | setNodeZoneInfo (const ZoneIdType nodeZoneId, const NodeZoneInfoType nodeZoneInfoType, const int info) const |
| set certain zone level info for a node zone. More... | |
| void | getNodeZoneInfo (const ZoneIdType nodeZoneId, const NodeZoneInfoType nodeZoneInfoType, int &info) const |
| get certain zone level info for a node zone. More... | |
| void | setAllFaceZoneFlags (const ZoneIdType faceZoneId, const int allFlags) |
| Set flags for a face zone. More... | |
| void | getAllFaceZoneFlags (const ZoneIdType faceZoneId, int &allFlags) const |
| Get flags for a face zone. More... | |
| void | setFaceZoneType (const ZoneIdType faceZoneId, const FaceZoneType zoneType) |
| set zone type of a face zone. More... | |
| void | getFaceZoneType (const ZoneIdType faceZoneId, FaceZoneType &zoneType) const |
| get the zone type of a face zone. More... | |
| void | setFaceZoneInfo (const ZoneIdType faceZoneId, const FaceZoneInfoType faceZoneInfoType, const int info) const |
| set certain zone level info for a face zone. More... | |
| void | getFaceZoneInfo (const ZoneIdType faceZoneId, const FaceZoneInfoType faceZoneInfoType, int &info) const |
| get certain zone level info for a face zone. More... | |
| void | setFaceZoneProp (const ZoneIdType faceZoneId, const FaceZonePropType faceZonePropType) |
| bool | getFaceZoneProp (const ZoneIdType faceZoneId, const FaceZonePropType) const |
| void | setZoneSizeInfo (const ZoneIdType zoneId, const ZoneSizeType sizeType, const ElemIdType size) |
| Sets a size setting of a zone. More... | |
| void | getZoneSizeInfo (const ZoneIdType zoneId, const ZoneSizeType sizeType, ElemIdType &size) const |
| Obtains a size setting of a zone. More... | |
| void | setCellZoneInfo (const ZoneIdType cellZoneId, const CellZoneInfoType cellZoneInfoType, const int info) |
| set certain zone level info for a cell zone. More... | |
| void | getCellZoneInfo (const ZoneIdType cellZoneId, const CellZoneInfoType cellZoneInfoType, int &info) const |
| get certain zone level info for a cell zone. More... | |
| void | setEdgeZoneType (const ZoneIdType edgeZoneId, const EdgeZoneType zoneType) |
| set zone type of a edge zone. More... | |
| void | getEdgeZoneType (const ZoneIdType edgeZoneId, EdgeZoneType &zoneType) const |
| get the zone type of a edge zone. More... | |
| void | setEdgeZoneInfo (const ZoneIdType edgeZoneId, const EdgeZoneInfoType edgeZoneInfoType, const int info) |
| set certain zone level info for a edge zone. More... | |
| void | getEdgeZoneInfo (const ZoneIdType edgeZoneId, const EdgeZoneInfoType edgeZoneInfoType, int &info) const |
| get certain zone level info for a edge zone. More... | |
| void | setZoneStringInfo (const ZoneIdType zoneId, const ZoneStringInfoType type, const std::string &info) |
| Sets a string value associated with a zone. More... | |
| void | getZoneStringInfo (const ZoneIdType zoneId, const ZoneStringInfoType type, std::string &info) const |
| Obtains a string value associated with a zone. More... | |
| void | getFaceCellZone0Ids (const ZoneIdType faceZoneId, std::list< ZoneIdType > &zoneIds) |
| Get a list of cell zones on side zero of a face zone. More... | |
| void | getFaceCellZone1Ids (const ZoneIdType faceZoneId, std::list< ZoneIdType > &zoneIds) |
| Get a list of cell zones on side one of a face zone. More... | |
| void | getCellFaceZoneIds (const ZoneIdType cellZoneId, std::list< ZoneIdType > &zoneIds) |
| Get a list of face zones touching a cell zone. More... | |
| virtual void | setSolverType (SolverType solverType) |
| Set the name of the application that is supplying the data. More... | |
| SolverType | getSolverType () const |
| Obtains the owner of the data in the model. More... | |
| const CffLocationModel * | getLocationModel () const |
| Get a query interface to the underlying topology model. More... | |
| void | setVariableAttributeProvider (const CffVariableAttributeProvider *, bool takeOwnership=false) |
| Register an alternative variable attribute provider. More... | |
| CffMessageRegistrar * | getMessageRegistrar () const |
| Obtains a message registrar object so that external plug-ins can register messages with the API. More... | |
| bool | hasError () const |
| returns whether there are unprocessed error messages registered. More... | |
| bool | hasWarning () const |
| returns whether there are unprocessed warning messages registered. More... | |
| bool | hasInfo () const |
| returns whether there are unprocessed informative messages registered. More... | |
| std::vector< std::string > | getErrors (bool formated=true, bool clear=false) const |
| returns, as strings, any unprocessed error messages registered More... | |
| std::vector< std::string > | getWarnings (bool formated=true, bool clear=false) const |
| returns, as strings, any unprocessed warning messages registered More... | |
| std::vector< std::string > | getInfos (bool formated=true, bool clear=false) const |
| returns, as strings, any unprocessed information messages registered More... | |
| void | registerSettingsParser (CffSettingsParser *) |
| Sets a parser for processing settings. More... | |
| bool | addSetting (const DataClass dataClass, const std::string &key, const std::string &value, const SolverType &solverType="CFF_GENERIC") |
| Sets a specific setting by supplying a key and a value. More... | |
| bool | addSettingsDataSet (const DataClass dataClass, const std::string &dataSetPath, const std::string &data, const SolverType &solverType="CFF_GENERIC", const std::vector< std::string > &settingsKeys=std::vector< std::string >()) |
| Defines a set of data that contain the more than one setting. More... | |
| void | setApplicationName (const std::string &applicationName) |
| Sets an application name for error purposes and when logging to a file. More... | |
| void | getPhaseIds (PhaseIds &phaseIds) const |
| Obtain the Identifiers of all Phase. More... | |
| bool | getPhaseName (const PhaseIdType phaseId, PhaseName &phaseName) const |
| Obtain the unique name a specific Phase. More... | |
| PhaseName | getPhaseName (const PhaseIdType phaseId) const |
| Obtain the unique name a specific Phase. More... | |
| const TimeLevels & | getTimeLevels () const |
| TimeLevelType | getTimeLevel () const |
| Public Member Functions inherited from ansys::CffVersion | |
| CffVersion () | |
| ~CffVersion () | |
| Public Member Functions inherited from ansys::CffFileIO | |
| CffFileIO () | |
| virtual | ~CffFileIO () |
| virtual void | setFile (const std::string &file, DataClass dataClass) |
| virtual bool | getFileVersion (DataClass dataClass, std::string &version) const |
| virtual bool | getFileVersion (DataClass dataClass, int &major, int &minor, int &patch) const |
| virtual void | setFormat (bool isBinary=true) |
| Sets the output format (VTP/VTU files only). More... | |
Protected Member Functions | |
| virtual bool | openData (DataClass dataClass, const std::string &file) |
| virtual bool | closeData (DataClass dataClass) |
| Protected Member Functions inherited from ansys::CffProvider | |
| bool | fileExists (const std::string &) const |
| void | setReading (DataClass, bool) |
| Set whether a reading of the class of data specified is possible. More... | |
| void | applyVariableRecipe (VariableIdType varId, AttributeName name, AttributeValue &value) const |
| Protected Member Functions inherited from ansys::CffBase | |
| CffReadable | isSupported (const std::string &version) const |
| Check whether the version can be read by this version of the CFF SDK. More... | |
| void | setMeshSize (const ElemIdType nDims, const ElemIdType nodesCount, const ElemIdType edgesCount, const ElemIdType facesCount, const ElemIdType cellsCount) |
| Set the mesh size info This function is for providing top level meta data: the total mesh size of all zones In case you do not save certain entity, for example, edges, then the input edgesCount should be 0. More... | |
| virtual void | setZoneAdjacency () |
| void | setFaceCellZone0Ids (const std::map< ZoneIdType, std::list< ZoneIdType > > &) |
| Set the c0 cell zones of all face zones The CellZone0 (c0) cell zones are the cell zones adjacent to the face zone and at the side of face normal direction The information provided here will be helpful for quicker establishment of zone level topology when reading the mesh Mesh without those information can still be read, but would be much slower. More... | |
| void | setFaceCellZone1Ids (const std::map< ZoneIdType, std::list< ZoneIdType > > &) |
| Set the c1 cell zones of all face zones The CellZone1 (c1) cell zones are the cell zones adjacent to the face zone and at the side opposite to face normal direction The information provided here will be helpful for quicker establishment of zone level topology when reading the mesh Mesh without those information can still be read, but would be much slower. More... | |
| void | getFaceCellZone0Ids (std::map< ZoneIdType, std::list< ZoneIdType > > &) |
| void | getFaceCellZone1Ids (std::map< ZoneIdType, std::list< ZoneIdType > > &) |
| void | setCellFaceZoneIds (const std::map< ZoneIdType, std::list< ZoneIdType > > &) |
| Set the face zones ids of all cell zones The face zones of a cell zone are all face zones that adjacent to the cell zone The information provided here will be helpful for quicker establishment of zone level topology when reading the mesh Mesh without those information can still be read, but would be much slower. More... | |
| void | getSortedMinIdZoneId (const ZoneCategory, std::vector< std::pair< ElemIdType, ZoneIdType > > &minIdZoneId) const |
| std::string | getGroupNameForPhase (PhaseIdType phaseId) const |
| CffSolutionModel * | solutionModel () const |
| virtual void | initLocationModel () const |
| CffLocationModel * | locationModel () const |
| void | initializeVariableAttributeProvider (const SolverType &solverType, const std::string &variableTarget) |
| virtual bool | updateData (DataClass) |
| bool | setMeshContext (MeshId, TargetCategory, PartitionIdType, UpdateMethod=UpdateMethod::CaseAndResults) |
| virtual void | finalizeMeshContext () |
| void | setZoneCategory (const ZoneIds &, const ZoneCategory) |
| set the zone categories of all zones of the same zone category More... | |
| ZoneCategory | getZoneCategory (const ZoneIdType zoneId) const |
| get the zone category of a given zone by zone id More... | |
| void | addVariableOfCategory (VariableIdType, ZoneCategory) const |
| std::string | getApplicationName () const |
| Obtains the application name that was set by calling setApplicationName logging when writing a file. More... | |
| bool | getActivePhase (PhaseIdType &) const |
| bool | setActivePhase (PhaseIdType) const |
| bool | getActivePhase (PhaseName &) const |
| bool | setActivePhase (const PhaseName &) const |
| void | addTimeLevel (TimeLevelType) const |
| bool | setTimeLevel (TimeLevelType) const |
| Protected Member Functions inherited from ansys::CffFileIO | |
| std::vector< DataClass > | getDataClasses () const |
| std::string | getFile (DataClass source) const |
| virtual void | setFileVersion (DataClass dataClass, const std::string &version) |
Additional Inherited Members | |
| Static Public Member Functions inherited from ansys::CffVersion | |
| static unsigned int | getMajor () |
| static unsigned int | getMinor () |
| static unsigned int | getPatch () |
| static std::string | getSHA () |
| static bool | isBeta () |
| static std::string | apiVersionAsString (const std::string &separator=".") |
| static std::string | ansysApplicationVersion (const std::string &appName) |
| static std::string | copyright (bool allRightsReserved) |
| Static Public Attributes inherited from ansys::CffBase | |
| static std::string | _defaultSettingsPath = "settings" |
| Protected Types inherited from ansys::CffBase | |
| enum class | UpdateMethod { CaseOnly = 1 , ResultsOnly , CaseAndResults } |
| Protected Attributes inherited from ansys::CffBase | |
| std::unique_ptr< DataInterface > | _data |
| std::unique_ptr< const CffVariableAttributeProvider > | _varAttrProvider |
Detailed Description
Class that provides functions to access data stored within a CFF file.
Constructor & Destructor Documentation
◆ ~CffFileProvider()
|
virtual |
Destructor.
Member Function Documentation
◆ closeData()
|
protectedvirtual |
◆ endReading()
|
overridevirtual |
Stop reading data of the class from the filename that has been . previously opened with that data class.
- Parameters
-
dataClass [in] - Data class identifying which file should be closed.
- Returns
- - true if opened, or false otherwise.
- See also
- setFile, startReading, isReading
Reimplemented from ansys::CffProvider.
◆ getDatasetNameOfPhase()
|
virtual |
Unsupported - Do not use.
◆ getDatasetNameOfVariable()
|
virtual |
Unsupported - Do not use.
◆ openData()
|
protectedvirtual |
◆ startReading() [1/2]
| bool ansys::CffFileProvider::startReading | ( | const std::string & | file, |
| DataClass | dataClass | ||
| ) |
Start reading data of the class specified from the file passed in.
This function is equivilent to calling setFile and startReading with the same dataClass and file.
- Parameters
-
file [in] - The name of the file to open. dataClass [in] - The class of data the file is expected to contain.
- Returns
- - true if opened, or false otherwise.
- See also
- setFile, isReading, endReading
◆ startReading() [2/2]
|
overridevirtual |
Start reading data of the class from a filename that has been previously been associated with that data class.
- Parameters
-
dataClass [in] - The class of data the file is expected to contain.
- Returns
- - true if opened, or false otherwise.
- See also
- setFile, isReading, endReading
Reimplemented from ansys::CffProvider.
