ansys::CffFileConsumer Class Reference
Last update: 24.03.2026Class that provides functions to access data stored within a CFF file. More...
#include "CffInterface/CffFileConsumer.hpp"
Inheritance diagram for ansys::CffFileConsumer:
Public Member Functions | |
| virtual | ~CffFileConsumer () |
| bool | startWriting (const std::string &file, DataClass dataClass) |
| Start writing data of the specified class to the file passed as an argument. More... | |
| bool | startWriting (DataClass dataClass) override |
| Start writing a class of data. More... | |
| void | writeGenericSettings (DataClass dataClass, std::string key, std::string settings) |
| Directly write a dataset containing some settings. More... | |
| bool | endWriting (DataClass dataClass) override |
| Function to end writing to a file associated with a class of data. More... | |
| virtual void | setCombineContinuousZones (const bool ifCombZones) |
| Set whether zones should be combined into a single dataset where possible when reading. By default each zone of data is written to a separate dataset. More... | |
| virtual bool | setDatasetNameOfPhase (PhaseIdType, const std::string &) |
| Do not use. More... | |
| virtual bool | setDatasetNameOfVariable (VariableIdType, const std::string &) |
| Do not use. More... | |
Overwrite mode vs Append Mode | |
By default the CFF API will open a file in overwrite mode. All data in any existing file will be erased and subsequent operations will be added as if the file didn't exist prior to open. By default any settings provided by the caller are written when the file is closed. When processing in overwrite mode calling setWriteSettingsOn has no effect. It is also possible to append new meshes to a file. This is done by calling setAppendOn with true.
| |
| virtual void | setAppendOn (bool append) |
| Set whether when opening a file, it should be opened for append. More... | |
| virtual void | setWriteSettingsOn (bool writeSettings) |
| Set whether settings should be written automatically. More... | |
| virtual void | setOverrideSettingsOn (bool overrideSettings) |
| Set whether settings already found in the file should be overwritten when writing automatically (append mode only). More... | |
 Public Member Functions inherited from ansys::CffConsumer | |
| CffConsumer (const std::string &applicationName="Unknown") | |
| Constructor. More... | |
| virtual | ~CffConsumer () |
| Destructor. More... | |
| virtual void | log (const std::vector< std::pair< std::string, std::string > >, DataClass=DataClass::CFF_CASE) |
| virtual void | setIOMode (IOMode ioMode) |
| virtual void | setMPIComm (void *mpiComm) |
| virtual void | setCompression (int compression) |
| virtual bool | isWriting (DataClass dataClass) const |
| Return whether a file is currently being written. More... | |
| virtual bool | addStringAttribute (const std::string &file, const std::string &path, const std::string &name, const std::string &strAtt) |
| virtual void | inheritVariableAttributes (bool inheritVariableAttributes) |
| bool | isWritingData () const |
| DEPRECATED: Function to determine whether it is possible to write data of type ansys::DataClass::CFF_RESULTS. More... | |
| void | setDataPrecision (DataPrecisionType ptype) |
| Sets the precision for solution data. More... | |
| DataPrecisionType | getDataPrecision () const |
| Get the precision of solution data. More... | |
| virtual void | writeSettingStrings (const std::vector< std::pair< std::string, std::string > > &, DataClass=DataClass::CFF_CASE, const std::string &=CffBase::_defaultSettingsPath) const |
| Write settings to the CFF consumer. More... | |
| virtual void | writeSetting (CffSetting &setting, const std::string &key="Common", DataClass dataClass=DataClass::CFF_CASE, const std::string &rootName=CffBase::_defaultSettingsPath) const |
| Write a settings object to CFF consumer. More... | |
| virtual void | writeMeshAttributes () const |
| Write the global mesh size attributes and units to the active mesh. More... | |
| void | writeMeshSize () const |
| virtual void | setLocalElemIdsInZone (const ZoneIdType zoneId, const ElemIdType *const index, const size_t dataSize) |
| Provide a local element mapping to global element mapping. More... | |
| virtual void | startWritingNodes (const ZoneIds &zoneIds) const |
| virtual void | endWritingNodes () const |
| End writing nodes. More... | |
| virtual void | startWritingCoordinatesForNodes (const ZoneIds &zoneIds) const |
| Start writing the coorindinates for nodes. More... | |
| virtual void | setCoordinatesForNode (const ElemIdType nodeId, const float *const coords, const size_t) const |
| Define the coordinates for a specific node (single precision) More... | |
| virtual void | setCoordinatesForNodesInZone (const ZoneIdType zoneId, const float *const coords, const size_t) const |
| Provide the coordinates for all nodes in zone. More... | |
| virtual void | setCoordinatesForNodesInRange (const ElemIdType minId, const ElemIdType maxId, const float *const coords, const size_t) const |
| Provide the coordinates for all nodes in range. More... | |
| virtual void | setCoordinatesForNode (const ElemIdType nodeId, const double *const coords, const size_t) const |
| Define the coordinates for a specific node (double precision) More... | |
| virtual void | setCoordinatesForNodesInZone (const ZoneIdType zoneId, const double *const coords, const size_t) const |
| Provide the coordinates for all nodes in zone. More... | |
| virtual void | setCoordinatesForNodesInRange (const ElemIdType minId, const ElemIdType maxId, const double *const coords, const size_t) const |
| Provide the coordinates for all nodes in range. More... | |
| virtual void | endWritingCoordinatesForNodes () const |
| Finish writing coordinates for nodes. More... | |
| virtual void | startWritingEdges (const ZoneIds &zoneIds) const |
| Start writing information for elements in edge zones. More... | |
| virtual void | endWritingEdges () const |
| End writing data associated with edges. More... | |
| virtual void | startWritingNodesForEdges (const ZoneIds &zoneIds) const |
| Start writing nodes for edges within specified zones. More... | |
| virtual void | startWritingNodeCountsForEdges () const |
| Start writing the node counts for edge zones. More... | |
| virtual void | setUniformNodeCountForEdgesInRange (const ElemIdType minId, const ElemIdType maxId, const short unc) const |
| Set a uniform node count for all faces in a range. More... | |
| virtual void | setUniformNodeCountForEdgesInZone (const ZoneIdType zoneId, const short unc) const |
| Set a uniform node count for all faces in a zone. More... | |
| virtual void | setNodeCountForEdge (const ElemIdType edgeId, const short nodeCount) const |
| Set the number of nodes that define an edge. More... | |
| virtual void | setNodeCountsForEdgesInRange (const ElemIdType minId, const ElemIdType maxId, const short *const nodeCounts, const size_t) const |
| Set the number of nodes that define a range of edges. More... | |
| virtual void | setNodeCountsForEdgesInZone (const ZoneIdType zoneId, const short *const nodeCounts, const size_t) const |
| Set the number of nodes that define a edge zone. More... | |
| virtual void | endWritingNodeCountsForEdges () const |
| End writing the node counts for edges. More... | |
| virtual void | startWritingNodeIdsForEdges () const |
| Start writing the node ids for edges. More... | |
| virtual void | setNodeIdsForEdge (const ElemIdType edgeId, const ElemIdType *const nodeIds, const size_t) const |
| Provide the ids of the nodes for a single edge. More... | |
| virtual void | setNodeIdsForEdgesInRange (const ElemIdType minId, const ElemIdType maxId, const ElemIdType *const nodeIds, const size_t) const |
| Provide the ids of the nodes for a range of edges. More... | |
| virtual void | setNodeIdsForEdgesInZone (const ZoneIdType zoneId, const ElemIdType *const nodeIds, const size_t) const |
| Provide the ids of the nodes for all edges in an edge zone. More... | |
| virtual void | endWritingNodeIdsForEdges () const |
| End writing node ids for edges. More... | |
| virtual void | endWritingNodesForEdges () const |
| End writing nodes for edges. More... | |
| virtual void | setFaceCellZone0Ids (const ZoneIdType zoneId, const ZoneIds &cellZoneIds) const |
| Set the cell zones adjacent on side 0 of the supplied face zone. More... | |
| virtual void | setFaceCellZone1Ids (const ZoneIdType zoneId, const ZoneIds &cellZoneIds) const |
| Set the cell zones adjacent on side 1 of the supplied face zone. More... | |
| virtual void | startWritingFaces (const ZoneIds &zoneIds) const |
| Start of writing faces. More... | |
| virtual void | endWritingFaces () const |
| End of writing face data. More... | |
| virtual void | startWritingNodesForFaces (const ZoneIds &zoneIds) const |
| Start writing faces nodes. More... | |
| virtual void | startWritingNodeCountsForFaces () const |
| Start writing node counts for faces. More... | |
| virtual void | setUniformNodeCountForFacesInRange (const ElemIdType minId, const ElemIdType maxId, const short unc) const |
| Set a uniform node count for the faces in a range. More... | |
| virtual void | setUniformNodeCountForFacesInZone (const ZoneIdType zoneId, const short unc) const |
| Set a uniform node count for the faces in a zone. More... | |
| virtual void | setNodeCountForFace (const ElemIdType faceId, const short nodeCount) const |
| Define the node count for the face supplied. More... | |
| virtual void | setNodeCountsForFacesInRange (const ElemIdType minId, const ElemIdType maxId, const short *const nodeCounts, const size_t) const |
| Define the node count for the faces in the range supplied. More... | |
| virtual void | setNodeCountsForFacesInZone (const ZoneIdType zoneId, const short *const nodeCounts, const size_t) const |
| Define the node count for the faces in the zone. More... | |
| virtual void | endWritingNodeCountsForFaces () const |
| End writing faces node counts. More... | |
| virtual void | startWritingNodeIdsForFaces () const |
| Start writing faces node ids. More... | |
| virtual void | setNodeIdsForFace (const ElemIdType faceId, const ElemIdType *const nodeIds, const size_t) const |
| set the node ids of single face More... | |
| virtual void | setNodeIdsForFacesInRange (const ElemIdType minId, const ElemIdType maxId, const ElemIdType *const nodeIds, const size_t) const |
| set the node ids of faces in a range More... | |
| virtual void | setNodeIdsForFacesInZone (const ZoneIdType zoneId, const ElemIdType *const nodeIds, const size_t) const |
| set the node ids for all faces in a face zone More... | |
| virtual void | endWritingNodeIdsForFaces () const |
| End of writing faces node ids. More... | |
| virtual void | endWritingNodesForFaces () const |
| End of writing faces nodes. More... | |
| virtual void | startWritingCell0sForFaces (const ZoneIds &zoneIds) const |
| Start writing cell0 cell ids for faces. More... | |
| virtual void | setCell0ForFace (const ElemIdType faceId, const ElemIdType faceC0) const |
| set the c0 cell id of single face More... | |
| virtual void | setCell0sForFacesInRange (const ElemIdType minId, const ElemIdType maxId, const ElemIdType *const faceC0s, const size_t) const |
| set the c0 cell ids of faces in a range More... | |
| virtual void | setCell0sForFacesInZone (const ZoneIdType zoneId, const ElemIdType *const faceC0s, const size_t) const |
| set the c0 cell ids for all faces in a face zone More... | |
| virtual void | endWritingCell0sForFaces () const |
| End of writing cell0 of faces. More... | |
| virtual void | startWritingCell1sForFaces (const ZoneIds &zoneIds) const |
| Start writing cell1 cell ids for faces. More... | |
| virtual void | setCell1ForFace (const ElemIdType faceId, const ElemIdType faceC1) const |
| set the c1 cell id of single face More... | |
| virtual void | setCell1sForFacesInRange (const ElemIdType minId, const ElemIdType maxId, const ElemIdType *const faceC1s, const size_t) const |
| set the c1 cell ids of faces in a range More... | |
| virtual void | setCell1sForFacesInZone (const ZoneIdType zoneId, const ElemIdType *const faceC1s, const size_t) const |
| set the c1 cell ids for all faces in a face zone More... | |
| virtual void | endWritingCell1sForFaces () const |
| End of writing cell1 of faces. More... | |
| virtual void | startWritingShadowFaceIdsForFaces (const ZoneIds &zoneIds) const |
| Start writing shadow faces of faces. More... | |
| virtual void | setShadowFaceIdForFace (const ElemIdType faceId, const ElemIdType shadowFaceId) const |
| set the shadow face id of single face More... | |
| virtual void | setShadowFaceIdsForFacesInRange (const ElemIdType minId, const ElemIdType maxId, const ElemIdType *const faceShadows, const size_t) const |
| Set the shadows face ids of faces in a range. More... | |
| virtual void | setShadowFaceIdsForFacesInZone (const ZoneIdType zoneId, const ElemIdType *const faceShadows, const size_t) const |
| set the shadows face ids for all faces in a face zone More... | |
| virtual void | endWritingShadowFaceIdsForFaces () const |
| End of writing shadow faces ids. More... | |
| virtual void | startWritingInterfaceDataForFaces (const ZoneIds &, const std::vector< int > &) const |
| virtual void | setInterfaceDataForFacesInZone (const ZoneIdType, const double *const, const size_t, const double *const, const size_t, const size_t *const, const size_t, const size_t *const =NULL, const size_t=0) const |
| virtual void | setInterfaceDataForFacesInZone (const ZoneIdType, const float *const, const size_t, const float *const, const size_t, const size_t *const, const size_t, const size_t *const =NULL, const size_t=0) const |
| virtual void | endWritingInterfaceDataForFaces () const |
| virtual void | startWritingChildFacesForFaces (const ZoneIds &) const |
| Start writing refined face data for faces in specified zones. More... | |
| virtual void | startWritingChildFaceCountsForFaces () const |
| Start writing refined child face counts for faces. More... | |
| virtual void | setChildFaceCountForFace (const ElemIdType faceId, const short childCount) const |
| Set a refined child face count for a single face. More... | |
| virtual void | setChildFaceCountsForFacesInRange (const ElemIdType, const ElemIdType, const short *const, const size_t) const |
| Set a refined child face counts for a range of faces. More... | |
| virtual void | setChildFaceCountsForFacesInZone (const ZoneIdType, const short *const, const size_t) const |
| Set a refined child face counts for all faces in a zone. More... | |
| virtual void | setUniformChildFaceCountForFacesInRange (const ElemIdType, const ElemIdType, const short) const |
| Set a uniformed refined child face count for a face range. More... | |
| virtual void | setUniformChildFaceCountForFacesInZone (const ZoneIdType, const short) const |
| Set a uniformed refined child face count for all faces in a zone. More... | |
| virtual void | endWritingChildFaceCountsForFaces () const |
| End writing refined child face counts. More... | |
| virtual void | startWritingChildFaceIdsForFaces () const |
| Start writing refined child face ids. More... | |
| virtual void | setChildFaceIdsForFace (const ElemIdType faceId, const ElemIdType *const childIds, const size_t dataSize) const |
| Write refined child face ids for a face. More... | |
| virtual void | setChildFaceIdsForFacesInRange (const ElemIdType, const ElemIdType, const ElemIdType *const, const size_t) const |
| Write refined child face ids for faces in a range. More... | |
| virtual void | setChildFaceIdsForFacesInZone (const ZoneIdType, const ElemIdType *const, const size_t) const |
| Write refined child face ids for all faces in a zone. More... | |
| virtual void | endWritingChildFaceIdsForFaces () const |
| Finish writing refined child face ids. More... | |
| virtual void | endWritingChildFacesForFaces () const |
| Finish writing refined child face data. More... | |
| virtual void | startWritingCells (const ZoneIds &) const |
| Start writing cells. More... | |
| virtual void | endWritingCells () const |
| End of writing cells. More... | |
| virtual void | startWritingTypesForCells (const ZoneIds &, const std::vector< CellType > &) const |
| Start writing cells types. More... | |
| virtual void | setTypeForCell (const ElemIdType cellId, const CellType cellType) const |
| set the cell type of single cell More... | |
| virtual void | setTypesForCellsInRange (const ElemIdType, const ElemIdType, const CellType *const, const size_t) const |
| set the cell element types of cells in a range More... | |
| virtual void | setTypesForCellsInZone (const ZoneIdType, const CellType *const cellTypes, const size_t) const |
| set the cell element types for all cells in a cell zone More... | |
| virtual void | endWritingTypesForCells () const |
| End of writing cell types. More... | |
| virtual void | startWritingNodesForCells (const ZoneIds &zoneIds) const |
| Start writing cell nodes. More... | |
| virtual void | startWritingNodeCountsForCells () const |
| Start writing counts for cell nodes. More... | |
| virtual void | setNodeCountForCell (const ElemIdType cellId, const short nodeCount) const |
| set the node count for single cell More... | |
| virtual void | setNodeCountsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, const short *const nodeCounts, const size_t) const |
| Set the node counts for several cells. More... | |
| virtual void | setNodeCountsForCellsInZone (const ZoneIdType zoneId, const short *const nodeCounts, const size_t) const |
| set the node counts for all cells in an cell zone More... | |
| virtual void | setUniformNodeCountForCellsInRange (const ElemIdType minId, const ElemIdType maxId, const short unc) const |
| virtual void | setUniformNodeCountForCellsInZone (const ZoneIdType zoneId, const short unc) const |
| virtual void | endWritingNodeCountsForCells () const |
| End of writing counts for cell nodes. More... | |
| virtual void | startWritingNodeIdsForCells () const |
| Start writing ids for cell nodes. More... | |
| virtual void | setNodeIdsForCell (const ElemIdType cellId, const ElemIdType *const nodeIds, const size_t dataSize) const |
| set the node ids of single cell More... | |
| virtual void | setNodeIdsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, const ElemIdType *const nodeIds, const size_t) const |
| set the node ids of cells in a range More... | |
| virtual void | setNodeIdsForCellsInZone (const ZoneIdType zoneId, const ElemIdType *const nodeIds, const size_t) const |
| set the node ids for all cells in a cell zone More... | |
| virtual void | endWritingNodeIdsForCells () const |
| End of writing ids for cell nodes. More... | |
| virtual void | endWritingNodesForCells () const |
| End of writing cell nodes. More... | |
| virtual void | startWritingFacesForCells (const ZoneIds &zoneIds) const |
| Start writing cell faces. More... | |
| virtual void | startWritingFaceCountsForCells () const |
| Start writing count of cell faces. More... | |
| virtual void | setFaceCountForCell (const ElemIdType cellId, const short faceCount) const |
| set the face count for single cell More... | |
| virtual void | setFaceCountsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, const short *const faceCounts, const size_t dataSize) const |
| Set the face counts for several cells. More... | |
| virtual void | setFaceCountsForCellsInZone (const ZoneIdType zoneId, const short *const faceCounts, const size_t) const |
| set the face counts for all cells in an cells zone More... | |
| virtual void | setUniformFaceCountForCellsInRange (const ElemIdType minId, const ElemIdType maxId, const short unc) const |
| virtual void | setUniformFaceCountForCellsInZone (const ZoneIdType zoneId, const short unc) const |
| virtual void | endWritingFaceCountsForCells () const |
| End of writing counts of cells faces. More... | |
| virtual void | startWritingFaceIdsForCells () const |
| Start writing ids of cell faces. More... | |
| virtual void | setFaceIdsForCell (const ElemIdType cellId, const ElemIdType *const faceIds, const size_t dataSize) const |
| set the face ids of single cell More... | |
| virtual void | setFaceIdsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, const ElemIdType *const faceIds, const size_t dataSize) const |
| set the face ids of cells in a range More... | |
| virtual void | setFaceIdsForCellsInZone (const ZoneIdType zoneId, const ElemIdType *const faceIds, const size_t) const |
| set the face ids for all cells in a cell zone More... | |
| virtual void | endWritingFaceIdsForCells () const |
| End of writing ids of cells faces. More... | |
| virtual void | endWritingFacesForCells () const |
| End of writing cells faces. More... | |
| virtual void | startWritingPartitionIdsForCells (const ZoneIds &, const int) const |
| Start writing partition ids for cells. More... | |
| virtual void | setPartitionIdForCell (const ElemIdType cellId, const PartitionIdType partId) const |
| set the partition id for single cell More... | |
| virtual void | setPartitionIdsForCellsInRange (const ElemIdType, const ElemIdType, const PartitionIdType *const partIds, const size_t) const |
| Set the partition ids for several cells. More... | |
| virtual void | setPartitionIdsForCellsInZone (const ZoneIdType, const PartitionIdType *const partIds, const size_t) const |
| set the partition ids for all cells in an cells zone More... | |
| virtual void | endWritingPartitionIdsForCells () const |
| End of writing partition ids for cells. More... | |
| virtual void | startWritingChildCellsForCells (const ZoneIds &) const |
| virtual void | startWritingChildCellCountsForCells () const |
| virtual void | setChildCellCountForCell (const ElemIdType cellId, const short childCount) const |
| virtual void | setChildCellCountsForCellsInRange (const ElemIdType, const ElemIdType, const short *const, const size_t) const |
| virtual void | setChildCellCountsForCellsInZone (const ZoneIdType, const short *const, const size_t) const |
| virtual void | setUniformChildCellCountForCellsInRange (const ElemIdType, const ElemIdType, const short) const |
| virtual void | setUniformChildCellCountForCellsInZone (const ZoneIdType, const short) const |
| virtual void | endWritingChildCellCountsForCells () const |
| virtual void | startWritingChildCellIdsForCells () const |
| virtual void | setChildCellIdsForCell (const ElemIdType cellId, const ElemIdType *const childIds, const size_t dataSize) const |
| virtual void | setChildCellIdsForCellsInRange (const ElemIdType, const ElemIdType, const ElemIdType *const, const size_t) const |
| virtual void | setChildCellIdsForCellsInZone (const ZoneIdType, const ElemIdType *const, const size_t) const |
| virtual void | endWritingChildCellIdsForCells () const |
| virtual void | endWritingChildCellsForCells () const |
| virtual void | startWritingCaseSectionCategories (const ZoneCategory, const CategoryNames &) const |
| virtual void | startWritingCaseSectionDataForCategory (const CategoryName &, const ZoneIds &, const PlainDataType, const size_t) const |
| virtual void | setCaseSectionDataForElementsInRange (const ElemIdType, const ElemIdType, const void *const, const size_t) const |
| virtual void | setCaseSectionDataForElementsInZone (const ZoneIdType, const void *const, const size_t) const |
| virtual void | endWritingCaseSectionDataForCategory () const |
| virtual void | endWritingCaseSectionCategories () const |
| void | startWritingTimeLevel (const TimeLevelType=CffLatestTimeLevel) const |
| void | endWritingTimeLevel () const |
| virtual bool | addPhaseName (const PhaseName &phaseName, PhaseIdType &phaseId) const |
| Append a phase name (existing phases are not removed) More... | |
| virtual bool | addPhaseNames (const PhaseNames &phaseNames, PhaseIds &phaseIds) const |
| Append a number of phase names (existing phases are not removed) More... | |
| virtual bool | setAttributeValueOfPhase (PhaseIdType phaseId, const AttributeName &attributeName, const AttributeValue &attributeValue) const |
| virtual bool | setAttributeValueOfPhase (const PhaseName &phaseName, const AttributeName &attributeName, const AttributeValue &attributeValue) const |
| virtual bool | setAttributeValueOfPhase (const AttributeName &attributeName, const AttributeValue &attributeValue) const |
| virtual bool | setPhaseNames (const PhaseNames &phaseNames, PhaseIds &phaseIds) const |
| Define the set of unique phase names (all existing phase names and associated variables are deleted) More... | |
| virtual void | startWritingPhase (const PhaseIdType phaseId=1) const |
| Start writing a phase. More... | |
| virtual void | endWritingPhase () const |
| End of writing solution data for certain phase. More... | |
| virtual bool | addPhaseVariable (PhaseIdType phaseId, const VariableName &variableName, VariableIdType &variableId) const |
| Add a variable. More... | |
| virtual bool | addPhaseVariable (const PhaseName &phaseName, const VariableName &variableName, VariableIdType &variableId) const |
| Add a variable to the specified phase. More... | |
| virtual bool | addPhaseVariable (const VariableName &variableName, VariableIdType &variableId) const |
| Add a variable to the current phase. More... | |
| virtual bool | setPhaseVariablesOfCategory (const ZoneCategory zoneCategory, const VariableIds &ids) const |
| Add the variables in the currently active phase to zones of the category. More... | |
| virtual bool | setPhaseVariablesOfCategory (const ZoneCategory, const VariableNames &, VariableIds &) const |
| Add the variables in the currently active phase to zones of the category. More... | |
| virtual bool | setPhaseVariablesOfCategory (const ZoneCategory, const VariableNames &) const |
| Add the variables in the currently active phase to zones of the category. More... | |
| virtual void | startWritingZonesOfCategory (const ZoneCategory) const |
| Start writing solution data for zones of certain category. More... | |
| virtual bool | setAttributeValueOfPhaseVariable (VariableIdType variableId, const AttributeName &attributeName, const AttributeValue &attributeValue) const |
| virtual bool | setAttributeValueOfPhaseVariable (PhaseIdType phaseId, const VariableName &variableName, const AttributeName &attributeName, const AttributeValue &attributeValue) const |
| virtual bool | setAttributeValueOfPhaseVariable (const VariableName &variable, const AttributeName &attributeName, const AttributeValue &attributeValue) const |
| virtual void | startWritingPhaseVariableInZonesOfCategory (const ZoneCategory zoneCategory, const VariableIdType varId, ZoneIds &zoneIds, const size_t numCols) const |
| Start writing data for certain variable. More... | |
| virtual void | startWritingPhaseVariableInZonesOfCategory (const ZoneCategory zoneCategory, const VariableName &varName, ZoneIds &zoneIds, const size_t numCols) const |
| Start writing data for certain variable. More... | |
| virtual void | setValuesOfPhaseVariableForElementsInRange (const ElemIdType startId, const ElemIdType endId, const double *const vals, const size_t dataSize) const |
| Set the solution data values for all elements in certain range. More... | |
| virtual void | setValuesOfPhaseVariableForElementsInRange (const ElemIdType startId, const ElemIdType endId, const float *const vals, const size_t dataSize) const |
| Set the solution data values for all elements in certain range. More... | |
| virtual void | setValuesOfPhaseVariableForElementsInZone (const ZoneIdType zoneId, const double *const vals, const size_t dataSize) const |
| Set the solution data values for all elements in certain range. More... | |
| virtual void | setValuesOfPhaseVariableForElementsInZone (const ZoneIdType zoneId, const float *const vals, const size_t dataSize) const |
| Set the solution data values for all elements in certain range. More... | |
| virtual void | endWritingPhaseVariableInZonesOfCategory () const |
| End of writing one variable in certain zone category. More... | |
| virtual void | endWritingZonesOfCategory () |
| End of writing solution data in certain zone category. More... | |
| virtual void | startWritingSetData (const DataClass dataClass, const ZoneCategory cat, const std::string &setName) |
| virtual void | startWritingIdsForSetData () |
| virtual size_t | setIdsForSetData (const ElemIdType *const setId, const size_t dataSize, const size_t chunkId=0) |
| virtual void | endWritingIdsForSetData () |
| virtual void | startWritingVariableForSetData (const VariableName &varName) |
| virtual size_t | setVariableForSetData (const unsigned char *const data, const size_t numRow, const size_t numCol, const size_t chunkId=0) |
| virtual size_t | setVariableForSetData (const char *const data, const size_t numRow, const size_t numCol, const size_t chunkId=0) |
| virtual size_t | setVariableForSetData (const short *const data, const size_t numRow, const size_t numCol, const size_t chunkId=0) |
| virtual size_t | setVariableForSetData (const unsigned int *const data, const size_t numRow, const size_t numCol, const size_t chunkId=0) |
| virtual size_t | setVariableForSetData (const int *const data, const size_t numRow, const size_t numCol, const size_t chunkId=0) |
| virtual size_t | setVariableForSetData (const long *const data, const size_t numRow, const size_t numCol, const size_t chunkId=0) |
| virtual size_t | setVariableForSetData (const long long *const data, const size_t numRow, const size_t numCol, const size_t chunkId=0) |
| virtual size_t | setVariableForSetData (const size_t *const data, const size_t numRow, const size_t numCol, const size_t chunkId=0) |
| virtual size_t | setVariableForSetData (const float *const data, const size_t numRow, const size_t numCol, const size_t chunkId=0) |
| virtual size_t | setVariableForSetData (const double *const data, const size_t numRow, const size_t numCol, const size_t chunkId=0) |
| virtual void | endWritingVariableForSetData () |
| virtual void | startWritingVariableLengthVariableForSetData (const VariableName &varName) |
| virtual size_t | setVariableLengthVariableForSetData (const unsigned char *const data, const size_t dataSize, const short *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const char *const data, const size_t dataSize, const short *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const short *const data, const size_t dataSize, const short *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const unsigned int *const data, const size_t dataSize, const short *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const int *const data, const size_t dataSize, const short *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const long *const data, const size_t dataSize, const short *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const long long *const data, const size_t dataSize, const short *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const size_t *const data, const size_t dataSize, const short *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const float *const data, const size_t dataSize, const short *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const double *const data, const size_t dataSize, const short *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const unsigned char *const data, const size_t dataSize, const size_t *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const char *const data, const size_t dataSize, const size_t *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const short *const data, const size_t dataSize, const size_t *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const unsigned int *const data, const size_t dataSize, const size_t *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const int *const data, const size_t dataSize, const size_t *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const long *const data, const size_t dataSize, const size_t *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const long long *const data, const size_t dataSize, const size_t *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const size_t *const data, const size_t dataSize, const size_t *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const float *const data, const size_t dataSize, const size_t *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const double *const data, const size_t dataSize, const size_t *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const unsigned char *const data, const size_t dataSize, const int *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const char *const data, const size_t dataSize, const int *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const short *const data, const size_t dataSize, const int *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const unsigned int *const data, const size_t dataSize, const int *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const int *const data, const size_t dataSize, const int *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const long *const data, const size_t dataSize, const int *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const long long *const data, const size_t dataSize, const int *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const size_t *const data, const size_t dataSize, const int *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const float *const data, const size_t dataSize, const int *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual size_t | setVariableLengthVariableForSetData (const double *const data, const size_t dataSize, const int *const size, const size_t sizeSize, const size_t chunkId=0) |
| virtual void | endWritingVariableLengthVariableForSetData () |
| virtual void | writeStringDataForSetData (const VariableName &varName, const std::string &data) |
| virtual void | writeOtherDataForSetData (const VariableName &varName, const unsigned char *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSetData (const VariableName &varName, const char *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSetData (const VariableName &varName, const short *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSetData (const VariableName &varName, const int *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSetData (const VariableName &varName, const unsigned int *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSetData (const VariableName &varName, const long *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSetData (const VariableName &varName, const long long *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSetData (const VariableName &varName, const size_t *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSetData (const VariableName &varName, const float *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSetData (const VariableName &varName, const double *const data, const size_t numCols, const size_t numRows) |
| virtual void | endWritingSetData () |
| virtual bool | startWritingParticleTracks (const PhaseIdType phaseId=-1, const MeshIdType meshId=-1, const TargetCategory target=TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN, const PartitionIdType partition=-1) |
| Start write particle tracks under phase specified by phaseId in the mesh set specified by mesh Id, target and partition. More... | |
| virtual void | startWritingPartiticleTrackGroup (const std::string &name="") |
| Start writing particle track group. More... | |
| virtual void | startWritingChunkInPartiticleTrackGroup (const size_t chunkIndex=0) |
| start writing chunk in particle track group, the input chunkIndex specifies More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableName &varName, const unsigned char *const data, const size_t numSteps, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableName &name, const char *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableName &name, const short *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableName &name, const unsigned int *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableName &name, const int *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableName &name, const long long *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableName &name, const long *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableName &name, const size_t *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableName &name, const float *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableName &name, const double *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableIdType VarId, const unsigned char *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableIdType VarId, const char *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableIdType VarId, const short *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableIdType VarId, const unsigned int *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableIdType VarId, const int *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableIdType VarId, const long *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableIdType VarId, const long long *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableIdType VarId, const size_t *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableIdType VarId, const float *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | setValuesOfParticleTrackVariable (const VariableIdType VarId, const double *const data, const size_t numElem, const size_t numCol=1, const bool asConstant=false) |
| Write variable to chunk. More... | |
| virtual void | endWritingChunkInPartiticleTrackGroup () |
| Finish writing particle track data in chunk of particle track group. More... | |
| virtual void | endWritingPartiticleTrackGroup () |
| Finish writing article track group. More... | |
| virtual void | endWritingParticleTracks () |
| Finish writing particle track group. More... | |
| void | setLocationModel (const CffLocationModel *) const |
| Write the location model. More... | |
| virtual void | startWritingSet (const DataClass dataClass, const ZoneCategory cat, const std::string &setName) |
| virtual void | setSizesAndMinMaxIdsForSet (const std::vector< size_t > &numElem, const std::vector< ElemIdType > &minIndices, const std::vector< ElemIdType > &maxIndices, const std::vector< ElemIdType > &minId, const std::vector< ElemIdType > &maxId) |
| virtual void | startWritingIdsForSet (const std::vector< ElemIdType > &minIndicies, const std::vector< ElemIdType > &maxIndicies, const std::vector< size_t > &numElem, const std::vector< ElemIdType > &minElemIds, const std::vector< ElemIdType > &maxElemIds) |
| virtual void | setIdsForSetInRange (const ElemIdType minIndex, const ElemIdType maxIndex, const ElemIdType minId, const ElemIdType maxId, const ElemIdType *const setId, const size_t dataSize) |
| virtual void | endWritingIdsForSet () |
| virtual void | startWritingDataOfVariableForSet (const VariableName &varName, const std::vector< size_t > numElem, const size_t dim, const PlainDataType type) |
| virtual void | setDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const unsigned char *const data, const size_t dataSize) |
| virtual void | setDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const char *const data, const size_t dataSize) |
| virtual void | setDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const short *const data, const size_t dataSize) |
| virtual void | setDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const unsigned int *const data, const size_t dataSize) |
| virtual void | setDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const int *const data, const size_t dataSize) |
| virtual void | setDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const long *const data, const size_t dataSize) |
| virtual void | setDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const long long *const data, const size_t dataSize) |
| virtual void | setDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const float *const data, const size_t dataSize) |
| virtual void | setDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const double *const data, const size_t dataSize) |
| virtual void | setDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const size_t *const data, const size_t dataSize) |
| virtual void | endWritingDataOfVariableForSet () |
| virtual void | startWritingSizeOfVariableForSet (const VariableName &varName, const std::vector< size_t > numElem, const PlainDataType dataType=PlainDataType::CFF_DATATYPE_SHORT) |
| virtual void | setSizeOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const CountType *const counts, const size_t dataSize) |
| virtual void | setSizeOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const CountType count, const size_t dataSize) |
| virtual void | setSizeOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const int *const counts, const size_t dataSize) |
| virtual void | setSizeOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const int count, const size_t dataSize) |
| virtual void | setSizeOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const size_t *const counts, const size_t dataSize) |
| virtual void | setSizeOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const size_t count, const size_t dataSize) |
| virtual void | endWritingSizeOfVariableForSet () |
| virtual void | startWritingVariableLengthedDataOfVariableForSet (const VariableName &varName, const PlainDataType type) |
| virtual void | setVariableLengthedDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const unsigned char *const data, const size_t dataSize) |
| virtual void | setVariableLengthedDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const char *const data, const size_t dataSize) |
| virtual void | setVariableLengthedDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const short *const data, const size_t dataSize) |
| virtual void | setVariableLengthedDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const int *const data, const size_t dataSize) |
| virtual void | setVariableLengthedDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const unsigned int *const data, const size_t dataSize) |
| virtual void | setVariableLengthedDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const long *const data, const size_t dataSize) |
| virtual void | setVariableLengthedDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const long long *const data, const size_t dataSize) |
| virtual void | setVariableLengthedDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const float *const data, const size_t dataSize) |
| virtual void | setVariableLengthedDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const double *const data, const size_t dataSize) |
| virtual void | setVariableLengthedDataOfVariableForSetInRange (const ElemIdType minId, const ElemIdType maxId, const size_t *const data, const size_t dataSize) |
| virtual void | endWritingVariableLengthedDataOfVariableForSet () |
| virtual void | writeStringDataForSet (const VariableName &varName, const std::string &data) |
| virtual void | writeOtherDataForSet (const VariableName &varName, const unsigned char *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSet (const VariableName &varName, const char *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSet (const VariableName &varName, const short *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSet (const VariableName &varName, const unsigned int *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSet (const VariableName &varName, const int *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSet (const VariableName &varName, const long *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSet (const VariableName &varName, const long long *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSet (const VariableName &varName, const double *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSet (const VariableName &varName, const float *const data, const size_t numCols, const size_t numRows) |
| virtual void | writeOtherDataForSet (const VariableName &varName, const size_t *const data, const size_t numCols, const size_t numRows) |
| virtual void | endWritingSet () |
| 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) |
| void | writeCommonSettings (DataClass dataClass) |
| Protected Member Functions inherited from ansys::CffConsumer | |
| virtual void | cacheLocationModelState (const std::string &state) const |
| bool | inheritVariableAttributes () const |
| virtual int | getLastLogIndex (DataClass dataClass=DataClass::CFF_CASE) const |
| void | setWriting (DataClass, bool) |
| Return whether a file is currently being written. More... | |
| 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
◆ ~CffFileConsumer()
|
inlinevirtual |
Member Function Documentation
◆ closeData()
|
protectedvirtual |
◆ endWriting()
|
overridevirtual |
Function to end writing to a file associated with a class of data.
The filename must have already been set using ansys::CffFileIO::setFile.
- Parameters
-
dataClass [in] - Class of data from which to identify the file.
- Returns
- - true if file is ready for writing, false in case of failure.
- See also
- setFile, isWriting, startWriting
Reimplemented from ansys::CffConsumer.
◆ openData()
|
protectedvirtual |
◆ setAppendOn()
|
virtual |
Set whether when opening a file, it should be opened for append.
This function should be called before calling startWriting.
- Note
- This function isn't currently supported for all operations and is limited to appending new meshes not specific zones to an existing mesh.
- Parameters
-
append [in] - true if file should be opened for append.
◆ setCombineContinuousZones()
|
virtual |
Set whether zones should be combined into a single dataset where possible when reading. By default each zone of data is written to a separate dataset.
- Note
- This functionality is implementation dependent and is only currently available when writing HDF5 based files.
- Parameters
-
ifCombZones [in] - true to combine data, false to write separately.
◆ setDatasetNameOfPhase()
|
virtual |
Do not use.
◆ setDatasetNameOfVariable()
|
virtual |
Do not use.
◆ setOverrideSettingsOn()
|
virtual |
Set whether settings already found in the file should be overwritten when writing automatically (append mode only).
This function should be called before calling startWriting.
- Parameters
-
overrideSettings [in] - true to allow overwrite, false otherwise.
- See also
- setAppendOn, setOverrideSettingsOn
◆ setWriteSettingsOn()
|
virtual |
Set whether settings should be written automatically.
This function should be called before calling startWriting.
- Note
- In append mode, settings are not overwritten unless explicitly overridden by calling setWriteSettingsOn with true.
- Parameters
-
writeSettings [in] - true when behavior is required.
- See also
- setWriteSettingsOn, setOverrideSettingsOn
◆ startWriting() [1/2]
| bool ansys::CffFileConsumer::startWriting | ( | const std::string & | file, |
| DataClass | dataClass | ||
| ) |
Start writing data of the specified class to the file passed as an argument.
This function is equivilent to calling setFile and then startWriting with the same dataClass for each function.
- Parameters
-
file [in] - Name of the file to start writing. dataClass [in] - Class of data to write to associate with the file.
- Returns
- - true if file is ready for writing, false in case of failure.
- See also
- setFile, isWriting, endWriting
◆ startWriting() [2/2]
|
overridevirtual |
Start writing a class of data.
The filename must have already been set using ansys::CffFileIO::setFile.
- Parameters
-
dataClass [in] - class of data to write
- Returns
- - true if file is ready for writing, false in case of failure.
- See also
- setFile, isWriting, endWriting
Reimplemented from ansys::CffConsumer.
◆ writeCommonSettings()
|
protected |
◆ writeGenericSettings()
| void ansys::CffFileConsumer::writeGenericSettings | ( | DataClass | dataClass, |
| std::string | key, | ||
| std::string | settings | ||
| ) |
Directly write a dataset containing some settings.
- Parameters
-
dataClass [in] - Write settings to the file associated with the class of data specified. key [in] - The dataset name to write. settings [in] - The settings to write to the dataset.
