Class that provides functions to write data within a CFF database. The database may be stored within a file or some other form of database but the functions provided in this class are common across all implementation and the data must be provided according to the rules defined in the CFF DataModels. More...

#include "CffInterface/CffConsumer.hpp"

Inheritance diagram for ansys::CffConsumer:

Public Member Functions
	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	startWriting (DataClass dataClass)

virtual bool	endWriting (DataClass dataClass)

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...

Settings
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...

Mesh Size, Units and Attributes
virtual void	writeMeshAttributes () const
	Write the global mesh size attributes and units to the active mesh. More...

void	writeMeshSize () const

Parallel Interface
virtual void	setLocalElemIdsInZone (const ZoneIdType zoneId, const ElemIdType *const index, const size_t dataSize)
	Provide a local element mapping to global element mapping. More...

Node Zones
virtual void	startWritingNodes (const ZoneIds &zoneIds) const

virtual void	endWritingNodes () const
	End writing nodes. More...

Node Coordinates
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...

Edge Zones
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...

Edge Nodes
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...

Face Zones
To read the nodes (vertices) for a specific face, specified face range or all faces within a face zone the following group of functions must be called. In this example the code is reading the nodes for all faces for the first zone that contains faces with nodes. // Create the provider ansys::CffProvider* provider = ...; provider->startReading(ansys::DataClass::CFF_CASE); // Obtain the zones containing vertices ansys::ZoneIds faceZones; provider->startReadingNodesForFaces(faceZones); if (!faceZones.empty()) { // Determine the size of the expected data from the zone size ansys::ElemIdType sz = 0; provider->getZoneSizeInfo(faceZones[0], CFF_ZONE_SIZE, sz); // Start reading node counts provider->startReadingNodeCountsForFaces(); short uniformNodeCount = 0; // First check to see if all faces are defined by a uniform node count bool isUniform = provider->hasUniformNodeCountForFacesInZone(faceZones[0], &uniformNodeCount); size_t totalNodeCount = 0; short* nodeCounts = nullptr; if (isUniform) { nodeCounts = &uniformNodeCount; totalNodeCount = uniformNodeCount * sz; } else { // Allocate the memory to store a node count per face nodeCounts = new short[sz]; provider->getNodeCountsForFacesInZone(faceZones[0], nodeCounts, sz); totalNodeCount = std::accumulate(nodeCounts, nodeCounts+sz, 0); } // Finish reading node counts provider->endReadingNodeCountsForFaces(); // Start reading nodes provider->startReadingNodeIdsForFaces(); // Allocate memory for the nodes themselves using total node count ansys::ElemIdType* nodes = new ansys::ElemIdType[totalNodeCount]; provider->getNodeIdsForFacesInZone(faceZones[0], nodes, totalNodeCount); // Process face nodes read // End reading node ids provider->endReadingNodeIdsForFaces(); // End reading nodes provider->endReadingNodesForFaces(); // End reading case provider->endReading(ansys::DataClass::CFF_CASE);
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...

Face Nodes
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...

Face Cell Parents
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...

Face Shadow Faces Mappings
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...

Interface Face Mappings
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

Face Zone Refinement (Child Faces)
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...

Cell Zones
virtual void	startWritingCells (const ZoneIds &) const
	Start writing cells. More...

virtual void	endWritingCells () const
	End of writing cells. More...

Cell Types
To read the type for a specific cell, specified cell range or all cells within a cell zone the following group of functions must be called. In this example the code is reading all the nodes for the first zone that contains cell types; // Create the provider ansys::CffProvider provider = ...; provider->startReading(ansys::DataClass::CFF_CASE); // Obtain the zones containing types ansys::ZoneIds cellZones; provider->startReadingTypesForCells(cellZones); if (!cellZones.empty()) { // Determine the size of the expected data from the zone size ansys::ElemIdType sz = 0; provider->getZoneSizeInfo(nodeZones[0], CFF_ZONE_SIZE, sz); // Start reading cell types - may be uniform or inndividual ansys::CellType uniformCellType; // First check to see if all cells have the same uniform type bool isUniform = provider->hasUniformTypesForCellsInZone(cellZones[0], &uniformCellType); if (!isUniform) { // Allocate the memory to store a node count per face ansys::CellType* types = new ansys::CellType[sz]; provider->getNodeCountsForFacesInZone(cellZones[0], types, sz); } } // Finish reading cell types provider->endReadingTypesForCells(); } // Finish reading the case data provider->endReading(ansys::DataClass::CFF_CASE);
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...

Cell Nodes
Note Cell/Node meshes only To read the nodes (vertices) for a specific cell, specified cell range or all cells within a cell zone the following group of functions must be called. In this example the code is reading the nodes for all cells for the first zone that contains cells with nodes. // Create the provider ansys::CffProvider provider = ...; provider->startReading(ansys::DataClass::CFF_CASE); // Obtain the zones containing nodes ansys::ZoneIds cellZones; provider->startReadingNodesForCells(CellZones); if (!cellZones.empty()) { // Determine the size of the expected data from the zone size ansys::ElemIdType sz = 0; provider->getZoneSizeInfo(cellZones[0], CFF_ZONE_SIZE, sz); // Start reading node counts provider->startReadingNodeCountsForCells(); short uniformNodeCount = 0; // First check to see if all Cells are defined by a uniform node count bool isUniform = provider->hasUniformNodeCountForCellsInZone(cellZones[0], &uniformNodeCount); size_t totalNodeCount = 0; short* nodeCounts = nullptr; if (isUniform) { nodeCounts = &uniformNodeCount; totalNodeCount = uniformNodeCount * sz; } else { // Allocate the memory to store a node count per cell nodeCounts = new short[sz]; provider->getNodeCountsForCellsInZone(cellZones[0], nodeCounts, sz); totalNodeCount = std::accumulate(nodeCounts, nodeCounts+sz, 0); } // Finish reading node counts provider->endReadingNodeCountsForCells(); // Start reading nodes provider->startReadingNodeIdsForCells(); // Allocate memory for the nodes themselves using total node count ansys::ElemIdType* nodes = new ansys::ElemIdType[totalNodeCount]; provider->getNodeIdsForCellsInZone(cellZones[0], nodes, totalNodeCount); // Process Cell nodes read // End reading node ids provider->endReadingNodeIdsForCells(); // End reading nodes provider->endReadingNodesForCells(); // End reading case provider->endReading(ansys::DataClass::CFF_CASE);
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...

Cell Faces
Note Should only be written for polyhedral cells in a CFF Post Data Model
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...

Cell Partitions
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...

Cell Zone Refinement (Child Cells)
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

Special Case Sections
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

Time Levels
void	startWritingTimeLevel (const TimeLevelType=CffLatestTimeLevel) const

void	endWritingTimeLevel () const

Phases and Phase Attributes
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...

Variables (Solution Phases)
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...

Set Data
Note Use these functions rather than those listed under Deprecated Set Data functions
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 ()

Solution Variables (Particle Track Phases)
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...

Location Model - Topology
See also Ansys Common Fluids Topology Data Model
void	setLocationModel (const CffLocationModel *) const
	Write the location model. More...

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 ()

Protected Member Functions
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

Data Precision/
void	setDataPrecision (DataPrecisionType ptype)
	Sets the precision for solution data. More...

DataPrecisionType	getDataPrecision () const
	Get the precision of solution data. More...

DEPRECATED Set Data functions
The functions listed under Set Data should be used Note These functions may be removed in a future release
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 ()

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 write data within a CFF database. The database may be stored within a file or some other form of database but the functions provided in this class are common across all implementation and the data must be provided according to the rules defined in the CFF DataModels.

ansys::CffConsumer* consumer = ansys::getDataConsumer(ansys::FileType::CFF_GENERIC);
consumer->startWriting(ansys::DataClass::CFF_CASE);
// Write data through consumer
consumer->endWriting(ansys::DataClass::CFF_CASE);
delete consumer;

Constructor & Destructor Documentation

◆ CffConsumer()

ansys::CffConsumer::CffConsumer ( const std::string & applicationName = "Unknown" )

Constructor.

◆ ~CffConsumer()

ansys::CffConsumer::~CffConsumer ( )

virtual

Destructor.

Destroys an instance of CffConsumer

Member Function Documentation

◆ addPhaseName()

bool ansys::CffConsumer::addPhaseName	(	const PhaseName &	phaseName,
		PhaseIdType &	phaseId
	)		const

virtual

Append a phase name (existing phases are not removed)

Note: If a phase name already exists it will return the existing phaseId

Parameters

phaseName	[in] - the phase to add
phaseId	[out] - the associated phase id return [out] - true if phase is defined or false

◆ addPhaseNames()

bool ansys::CffConsumer::addPhaseNames	(	const PhaseNames &	phaseNames,
		PhaseIds &	phaseIds
	)		const

virtual

Append a number of phase names (existing phases are not removed)

Note: If a phase name already exists it will return the existing phaseId

Parameters

phaseNames	[in] - the phase names to add
phaseIds	[out] - the associated phase ids

Returns: - true if phases are defined or false

◆ addPhaseVariable() [1/3]

bool ansys::CffConsumer::addPhaseVariable	(	const PhaseName &	phaseName,
		const VariableName &	varName,
		VariableIdType &	varId
	)		const

virtual

Add a variable to the specified phase.

Note: If a variable already exists it will return the existing id

Parameters

phaseName	[in] - the phase in which to add the variable
varName	[in] - the variable name to add
varId	[out] - the variable id if successful

Returns: - true if variable is defined or false

◆ addPhaseVariable() [2/3]

bool ansys::CffConsumer::addPhaseVariable	(	const VariableName &	variableName,
		VariableIdType &	variableId
	)		const

virtual

Add a variable to the current phase.

Note: If a variable already exists it will return the existing id

Parameters

variableName	[in] - the variable name to add
variableId	[out] - the variable id if successful

Returns: - true if variable is defined or false

◆ addPhaseVariable() [3/3]

bool ansys::CffConsumer::addPhaseVariable	(	PhaseIdType	phaseId,
		const VariableName &	varName,
		VariableIdType &	varId
	)		const

virtual

Add a variable.

Note: If a variable already exists it will return the existing id

Parameters

phaseId	[in] - the phase in which to add the variable
varName	[in] - the variable name to add
varId	[out] - the variable id if successful return [out] - true if variable is defined or false

◆ addStringAttribute()

bool ansys::CffConsumer::addStringAttribute	(	const std::string &	file,
		const std::string &	path,
		const std::string &	name,
		const std::string &	strAtt
	)

virtual

◆ cacheLocationModelState()

virtual void ansys::CffConsumer::cacheLocationModelState ( const std::string & state ) const

inlineprotectedvirtual

◆ endWriting()

virtual bool ansys::CffConsumer::endWriting ( DataClass dataClass )

inlinevirtual

Reimplemented in ansys::CffFileConsumer.

◆ endWritingCaseSectionCategories()

void ansys::CffConsumer::endWritingCaseSectionCategories ( ) const

virtual

◆ endWritingCaseSectionDataForCategory()

void ansys::CffConsumer::endWritingCaseSectionDataForCategory ( ) const

virtual

◆ endWritingCell0sForFaces()

void ansys::CffConsumer::endWritingCell0sForFaces ( ) const

virtual

End of writing cell0 of faces.

◆ endWritingCell1sForFaces()

void ansys::CffConsumer::endWritingCell1sForFaces ( ) const

virtual

End of writing cell1 of faces.

◆ endWritingCells()

void ansys::CffConsumer::endWritingCells ( ) const

virtual

End of writing cells.

◆ endWritingChildCellCountsForCells()

void ansys::CffConsumer::endWritingChildCellCountsForCells ( ) const

virtual

◆ endWritingChildCellIdsForCells()

void ansys::CffConsumer::endWritingChildCellIdsForCells ( ) const

virtual

◆ endWritingChildCellsForCells()

void ansys::CffConsumer::endWritingChildCellsForCells ( ) const

virtual

◆ endWritingChildFaceCountsForFaces()

void ansys::CffConsumer::endWritingChildFaceCountsForFaces ( ) const

virtual

End writing refined child face counts.

◆ endWritingChildFaceIdsForFaces()

void ansys::CffConsumer::endWritingChildFaceIdsForFaces ( ) const

virtual

Finish writing refined child face ids.

◆ endWritingChildFacesForFaces()

void ansys::CffConsumer::endWritingChildFacesForFaces ( ) const

virtual

Finish writing refined child face data.

◆ endWritingChunkInPartiticleTrackGroup()

void ansys::CffConsumer::endWritingChunkInPartiticleTrackGroup ( )

virtual

Finish writing particle track data in chunk of particle track group.

◆ endWritingCoordinatesForNodes()

void ansys::CffConsumer::endWritingCoordinatesForNodes ( ) const

virtual

Finish writing coordinates for nodes.

See also: startWritingCoordinatesForNodes, setCoordinatesForNode, setCoordinatesForNodesInRange, setCoordinatesForNodesInZone

◆ endWritingDataOfVariableForSet()

void ansys::CffConsumer::endWritingDataOfVariableForSet ( )

virtual

◆ endWritingEdges()

void ansys::CffConsumer::endWritingEdges ( ) const

virtual

End writing data associated with edges.

See also: startWritingEdges, startWritingNodesForEdges, endWritingNodesForEdges

◆ endWritingFaceCountsForCells()

void ansys::CffConsumer::endWritingFaceCountsForCells ( ) const

virtual

End of writing counts of cells faces.

◆ endWritingFaceIdsForCells()

void ansys::CffConsumer::endWritingFaceIdsForCells ( ) const

virtual

End of writing ids of cells faces.

◆ endWritingFaces()

void ansys::CffConsumer::endWritingFaces ( ) const

virtual

End of writing face data.

◆ endWritingFacesForCells()

void ansys::CffConsumer::endWritingFacesForCells ( ) const

virtual

End of writing cells faces.

◆ endWritingIdsForSet()

void ansys::CffConsumer::endWritingIdsForSet ( )

virtual

◆ endWritingIdsForSetData()

void ansys::CffConsumer::endWritingIdsForSetData ( )

virtual

◆ endWritingInterfaceDataForFaces()

void ansys::CffConsumer::endWritingInterfaceDataForFaces ( ) const

virtual

◆ endWritingNodeCountsForCells()

void ansys::CffConsumer::endWritingNodeCountsForCells ( ) const

virtual

End of writing counts for cell nodes.

◆ endWritingNodeCountsForEdges()

void ansys::CffConsumer::endWritingNodeCountsForEdges ( ) const

virtual

End writing the node counts for edges.

See also: startWritingNodesForEdges, setNodeCountsForEdge, setNodeCountsForEdgesInRange, setNodeCountsForEdgesInZone, setNodeCountForEdgesInZone, setUniformNodeCountForFacesInRange

◆ endWritingNodeCountsForFaces()

void ansys::CffConsumer::endWritingNodeCountsForFaces ( ) const

virtual

End writing faces node counts.

See also: startWritingNodeCountsForFaces, setNodeCountForFace, setNodeCountsForFacesInRange, setNodeCountsForFacesInZone, setUniformNodeCountForEdgesInRange, setUniformNodeCountForEdgesInZone

◆ endWritingNodeIdsForCells()

void ansys::CffConsumer::endWritingNodeIdsForCells ( ) const

virtual

End of writing ids for cell nodes.

◆ endWritingNodeIdsForEdges()

void ansys::CffConsumer::endWritingNodeIdsForEdges ( ) const

virtual

End writing node ids for edges.

See also: startWritingNodeIdsForEdges, setNodeIdsForEdge, setNodeIdsForEdgesInRange, setNodeIdsForEdgesInZone

◆ endWritingNodeIdsForFaces()

void ansys::CffConsumer::endWritingNodeIdsForFaces ( ) const

virtual

End of writing faces node ids.

◆ endWritingNodes()

void ansys::CffConsumer::endWritingNodes ( ) const

virtual

End writing nodes.

See also: startWritingNodes

◆ endWritingNodesForCells()

void ansys::CffConsumer::endWritingNodesForCells ( ) const

virtual

End of writing cell nodes.

◆ endWritingNodesForEdges()

void ansys::CffConsumer::endWritingNodesForEdges ( ) const

virtual

End writing nodes for edges.

See also: startWritingNodesForEdges, startWritingNodeCountsForEdges, endWritingNodeCountsForEdges, startWritingNodeIdsForEdges, endWritingNodeIdsForEdges

◆ endWritingNodesForFaces()

void ansys::CffConsumer::endWritingNodesForFaces ( ) const

virtual

End of writing faces nodes.

◆ endWritingParticleTracks()

void ansys::CffConsumer::endWritingParticleTracks ( )

virtual

Finish writing particle track group.

◆ endWritingPartiticleTrackGroup()

void ansys::CffConsumer::endWritingPartiticleTrackGroup ( )

virtual

Finish writing article track group.

◆ endWritingPartitionIdsForCells()

void ansys::CffConsumer::endWritingPartitionIdsForCells ( ) const

virtual

End of writing partition ids for cells.

◆ endWritingPhase()

void ansys::CffConsumer::endWritingPhase ( ) const

virtual

End of writing solution data for certain phase.

◆ endWritingPhaseVariableInZonesOfCategory()

void ansys::CffConsumer::endWritingPhaseVariableInZonesOfCategory ( ) const

virtual

End of writing one variable in certain zone category.

◆ endWritingSet()

void ansys::CffConsumer::endWritingSet ( )

virtual

◆ endWritingSetData()

void ansys::CffConsumer::endWritingSetData ( )

virtual

◆ endWritingShadowFaceIdsForFaces()

void ansys::CffConsumer::endWritingShadowFaceIdsForFaces ( ) const

virtual

End of writing shadow faces ids.

◆ endWritingSizeOfVariableForSet()

void ansys::CffConsumer::endWritingSizeOfVariableForSet ( )

virtual

◆ endWritingTimeLevel()

void ansys::CffConsumer::endWritingTimeLevel ( ) const

◆ endWritingTypesForCells()

void ansys::CffConsumer::endWritingTypesForCells ( ) const

virtual

End of writing cell types.

◆ endWritingVariableForSetData()

void ansys::CffConsumer::endWritingVariableForSetData ( )

virtual

◆ endWritingVariableLengthedDataOfVariableForSet()

void ansys::CffConsumer::endWritingVariableLengthedDataOfVariableForSet ( )

virtual

◆ endWritingVariableLengthVariableForSetData()

void ansys::CffConsumer::endWritingVariableLengthVariableForSetData ( )

virtual

◆ endWritingZonesOfCategory()

void ansys::CffConsumer::endWritingZonesOfCategory ( )

virtual

End of writing solution data in certain zone category.

◆ getDataPrecision()

DataPrecisionType ansys::CffConsumer::getDataPrecision ( ) const

protected

Get the precision of solution data.

Returns: The data precision.

◆ getLastLogIndex()

int ansys::CffConsumer::getLastLogIndex ( DataClass dataClass = DataClass::CFF_CASE ) const

protectedvirtual

◆ inheritVariableAttributes() [1/2]

bool ansys::CffConsumer::inheritVariableAttributes ( ) const

inlineprotected

◆ inheritVariableAttributes() [2/2]

virtual void ansys::CffConsumer::inheritVariableAttributes ( bool inheritVariableAttributes )

inlinevirtual

◆ isWriting()

bool ansys::CffConsumer::isWriting ( DataClass dataClass ) const

virtual

Return whether a file is currently being written.

Parameters

dataClass [in] - Class of data from which to identify the file.

Returns: - true if file is being written, false if not.

See also: startWriting, endWriting

◆ isWritingData()

bool ansys::CffConsumer::isWritingData ( ) const

DEPRECATED: Function to determine whether it is possible to write data of type ansys::DataClass::CFF_RESULTS.

Note: This function has been deprecated in favour of isWriting(DataClass) and will be removed in a future release.

◆ log()

virtual void ansys::CffConsumer::log	(	const std::vector< std::pair< std::string, std::string > >	,
		DataClass	= `DataClass::CFF_CASE`
	)

inlinevirtual

◆ setAttributeValueOfPhase() [1/3]

bool ansys::CffConsumer::setAttributeValueOfPhase	(	const AttributeName &	name,
		const AttributeValue &	value
	)		const

virtual

Set the value of an attribute in the active phase

Parameters

name	[in] - the attribute name to set
value	[in] - the attribute value to store return [out] - true if successful, or false

◆ setAttributeValueOfPhase() [2/3]

bool ansys::CffConsumer::setAttributeValueOfPhase	(	const PhaseName &	phaseName,
		const AttributeName &	name,
		const AttributeValue &	value
	)		const

virtual

Set the value of an attribute in a phase

Parameters

phaseName	[in] - the phase the attribute the associated with
name	[in] - the attribute name to set
value	[in] - the attribute value to store return [out] - true if successful, or false

◆ setAttributeValueOfPhase() [3/3]

bool ansys::CffConsumer::setAttributeValueOfPhase	(	PhaseIdType	phaseId,
		const AttributeName &	name,
		const AttributeValue &	value
	)		const

virtual

Set the value of an attribute in a phase

Parameters

phaseId	[in] - the phase the attribute the associated with
name	[in] - the attribute name to set
value	[in] - the attribute value to store return [out] - true if successful, or false

◆ setAttributeValueOfPhaseVariable() [1/3]

bool ansys::CffConsumer::setAttributeValueOfPhaseVariable	(	const VariableName &	varName,
		const AttributeName &	name,
		const AttributeValue &	value
	)		const

virtual

Set the value of an attribute in a variable in the active phase

Parameters

varName	(in) - the variable the attribute the associated with
name	(in) - the attribute name to set
value	(in) - the attribute value to store return (out) - true if successful, or false

◆ setAttributeValueOfPhaseVariable() [2/3]

bool ansys::CffConsumer::setAttributeValueOfPhaseVariable	(	PhaseIdType	phaseId,
		const VariableName &	varName,
		const AttributeName &	name,
		const AttributeValue &	value
	)		const

virtual

Set the value of an attribute in a variable in the supplied phase

Parameters

phaseId	(in) - the phase the variable belongs to
varName	(in) - the variable the attribute the associated with
name	(in) - the attribute name to set
value	(in) - the attribute value to store return (out) - true if successful, or false

◆ setAttributeValueOfPhaseVariable() [3/3]

bool ansys::CffConsumer::setAttributeValueOfPhaseVariable	(	VariableIdType	varId,
		const AttributeName &	name,
		const AttributeValue &	value
	)		const

virtual

Set the value of an attribute in a variable in the active phase

Parameters

varId	(in) - the variable the attribute the associated with
name	(in) - the attribute name to set
value	(in) - the attribute value to store return (out) - true if successful, or false

◆ setCaseSectionDataForElementsInRange()

void ansys::CffConsumer::setCaseSectionDataForElementsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const void * const	data,
		const size_t	dataSize
	)		const

virtual

◆ setCaseSectionDataForElementsInZone()

void ansys::CffConsumer::setCaseSectionDataForElementsInZone	(	const ZoneIdType	zoneId,
		const void * const	data,
		const size_t	dataSize
	)		const

virtual

◆ setCell0ForFace()

void ansys::CffConsumer::setCell0ForFace	(	const ElemIdType	faceId,
		const ElemIdType	faceC0
	)		const

virtual

set the c0 cell id of single face

Parameters

faceId	[in] - face Id
faceC0	[in] - the cell on the side 0 of the face

◆ setCell0sForFacesInRange()

void ansys::CffConsumer::setCell0sForFacesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const ElemIdType *const	faceC0s,
		const size_t	dataSize
	)		const

virtual

set the c0 cell ids of faces in a range

1) Will set c0 cell ids for all faces, whose face id is between minId and maxId 2) The face ids are supposed to be continuous in the range

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
faceC0s	[in] - c0 cell ids
dataSize	[in] - data size

◆ setCell0sForFacesInZone()

void ansys::CffConsumer::setCell0sForFacesInZone	(	const ZoneIdType	zoneId,
		const ElemIdType *const	faceC0s,
		const size_t	dataSize
	)		const

virtual

set the c0 cell ids for all faces in a face zone

Parameters

zoneId	[in] - face zone Id
faceC0s	[in] - c0 cell ids
dataSize	[in] - data size

◆ setCell1ForFace()

void ansys::CffConsumer::setCell1ForFace	(	const ElemIdType	faceId,
		const ElemIdType	faceC1
	)		const

virtual

set the c1 cell id of single face

Parameters

faceId	[in] - face Id
faceC1	[in] - the cell on the side 1 of the face

◆ setCell1sForFacesInRange()

void ansys::CffConsumer::setCell1sForFacesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const ElemIdType *const	faceC1s,
		const size_t	dataSize
	)		const

virtual

set the c1 cell ids of faces in a range

1) Will set c1 cell ids for all faces, whose face id is between minId and maxId 2) The face ids are supposed to be continuous in the range

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
faceC1s	[in] - c1 cell ids
dataSize	[in] - data size

◆ setCell1sForFacesInZone()

void ansys::CffConsumer::setCell1sForFacesInZone	(	const ZoneIdType	zoneId,
		const ElemIdType *const	faceC1s,
		const size_t	dataSize
	)		const

virtual

set the c1 cell ids for all faces in a face zone

Parameters

zoneId	[in] - face zone Id
faceC1s	[in] - c1 cell ids
dataSize	[in] - data size

◆ setChildCellCountForCell()

void ansys::CffConsumer::setChildCellCountForCell	(	const ElemIdType	cellId,
		const short	childCount
	)		const

virtual

◆ setChildCellCountsForCellsInRange()

void ansys::CffConsumer::setChildCellCountsForCellsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short * const	childCounts,
		const size_t	dataSize
	)		const

virtual

◆ setChildCellCountsForCellsInZone()

void ansys::CffConsumer::setChildCellCountsForCellsInZone	(	const ZoneIdType	zoneId,
		const short * const	childCounts,
		const size_t	dataSize
	)		const

virtual

◆ setChildCellIdsForCell()

void ansys::CffConsumer::setChildCellIdsForCell	(	const ElemIdType	cellId,
		const ElemIdType *const	childIds,
		const size_t	dataSize
	)		const

virtual

◆ setChildCellIdsForCellsInRange()

void ansys::CffConsumer::setChildCellIdsForCellsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const ElemIdType * const	childIds,
		const size_t	dataSize
	)		const

virtual

◆ setChildCellIdsForCellsInZone()

void ansys::CffConsumer::setChildCellIdsForCellsInZone	(	const ZoneIdType	zoneId,
		const ElemIdType * const	childIds,
		const size_t	dataSize
	)		const

virtual

◆ setChildFaceCountForFace()

void ansys::CffConsumer::setChildFaceCountForFace	(	const ElemIdType	faceId,
		const short	childCount
	)		const

virtual

Set a refined child face count for a single face.

◆ setChildFaceCountsForFacesInRange()

void ansys::CffConsumer::setChildFaceCountsForFacesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short * const	childCounts,
		const size_t	dataSize
	)		const

virtual

Set a refined child face counts for a range of faces.

◆ setChildFaceCountsForFacesInZone()

void ansys::CffConsumer::setChildFaceCountsForFacesInZone	(	const ZoneIdType	zoneId,
		const short * const	childCounts,
		const size_t	dataSize
	)		const

virtual

Set a refined child face counts for all faces in a zone.

◆ setChildFaceIdsForFace()

void ansys::CffConsumer::setChildFaceIdsForFace	(	const ElemIdType	faceId,
		const ElemIdType *const	childIds,
		const size_t	dataSize
	)		const

virtual

Write refined child face ids for a face.

◆ setChildFaceIdsForFacesInRange()

void ansys::CffConsumer::setChildFaceIdsForFacesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const ElemIdType * const	childIds,
		const size_t	dataSize
	)		const

virtual

Write refined child face ids for faces in a range.

◆ setChildFaceIdsForFacesInZone()

void ansys::CffConsumer::setChildFaceIdsForFacesInZone	(	const ZoneIdType	zoneId,
		const ElemIdType * const	childIds,
		const size_t	dataSize
	)		const

virtual

Write refined child face ids for all faces in a zone.

◆ setCompression()

virtual void ansys::CffConsumer::setCompression ( int compression )

inlinevirtual

◆ setCoordinatesForNode() [1/2]

void ansys::CffConsumer::setCoordinatesForNode	(	const ElemIdType	nodeId,
		const double *const	coords,
		const size_t	dataSize
	)		const

virtual

Define the coordinates for a specific node (double precision)

Parameters

nodeId	[in] - The node for which to set coordinates
coords	[in] - The coordinates
dataSize	[in] - The size of the coordinates array

Note: For a 2D mesh dataSize will be 2, for a 3D mesh it wil be 3

See also: startWritingCoordinatesForNodes, setCoordinatesForNodesInRange setCoordinatesForNodesInZone, endWritingCoordinatesForNodes

◆ setCoordinatesForNode() [2/2]

void ansys::CffConsumer::setCoordinatesForNode	(	const ElemIdType	nodeId,
		const float *const	coords,
		const size_t	dataSize
	)		const

virtual

Define the coordinates for a specific node (single precision)

Parameters

nodeId	[in] - The node for which to set coordinates
coords	[in] - The coordinates
dataSize	[in] - The size of the coordinates array

Note: For a 2D mesh dataSize will be 2, for a 3D mesh it wil be 3

See also: startWritingCoordinatesForNodes, setCoordinatesForNodesInRange setCoordinatesForNodesInZone, endWritingCoordinatesForNodes

◆ setCoordinatesForNodesInRange() [1/2]

void ansys::CffConsumer::setCoordinatesForNodesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const double *const	coords,
		const size_t	dataSize
	)		const

virtual

Provide the coordinates for all nodes in range.

The nodes for which coordinates will be set must be between the minId and maxId passed as arguments and will encompass all nodes in that range

Parameters

minId	[in] - First node
maxId	[in] - Last node
coords	[in] - The coordinates for all nodes
dataSize	[in] - The size of the coordinates array

See also: startWritingCoordinatesForNodes, setCoordinatesForNode, setCoordinatesForNodesInZone, endWritingCoordinatesForNodes

◆ setCoordinatesForNodesInRange() [2/2]

void ansys::CffConsumer::setCoordinatesForNodesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const float *const	coords,
		const size_t	dataSize
	)		const

virtual

Provide the coordinates for all nodes in range.

The nodes for which coordinates will be set must be between the minId and maxId passed as arguments and will encompass all nodes in that range

Parameters

minId	[in] - First node
maxId	[in] - Last node
coords	[in] - The coordinates for all nodes
dataSize	[in] - The size of the coordinates array

See also: startWritingCoordinatesForNodes, setCoordinatesForNode, setCoordinatesForNodesInZone, endWritingCoordinatesForNodes

◆ setCoordinatesForNodesInZone() [1/2]

void ansys::CffConsumer::setCoordinatesForNodesInZone	(	const ZoneIdType	zoneId,
		const double *const	coords,
		const size_t	dataSize
	)		const

virtual

Provide the coordinates for all nodes in zone.

Parameters

zoneId	[in] - The node zone for which coordinates are provided
coords	[in] - The coordinates for all nodes in the zone
dataSize	[in] - The size of the coordinates array

See also: startWritingCoordinatesForNodes, setCoordinatesForNode, setCoordinatesForNodesInRange, endWritingCoordinatesForNodes

◆ setCoordinatesForNodesInZone() [2/2]

void ansys::CffConsumer::setCoordinatesForNodesInZone	(	const ZoneIdType	zoneId,
		const float *const	coords,
		const size_t	dataSize
	)		const

virtual

Provide the coordinates for all nodes in zone.

Parameters

zoneId	[in] - The node zone for which coordinates are provided
coords	[in] - The coordinates for all nodes in the zone
dataSize	[in] - The size of the coordinates array

See also: startWritingCoordinatesForNodes, setCoordinatesForNode, setCoordinatesForNodesInRange, endWritingCoordinatesForNodes

◆ setDataOfVariableForSetInRange() [1/10]

void ansys::CffConsumer::setDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const char *const	data,
		const size_t	dataSize
	)

virtual

◆ setDataOfVariableForSetInRange() [2/10]

void ansys::CffConsumer::setDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const double *const	data,
		const size_t	dataSize
	)

virtual

◆ setDataOfVariableForSetInRange() [3/10]

void ansys::CffConsumer::setDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const float *const	data,
		const size_t	dataSize
	)

virtual

◆ setDataOfVariableForSetInRange() [4/10]

void ansys::CffConsumer::setDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const int *const	data,
		const size_t	dataSize
	)

virtual

◆ setDataOfVariableForSetInRange() [5/10]

void ansys::CffConsumer::setDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const long *const	data,
		const size_t	dataSize
	)

virtual

◆ setDataOfVariableForSetInRange() [6/10]

void ansys::CffConsumer::setDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const long long *const	data,
		const size_t	dataSize
	)

virtual

◆ setDataOfVariableForSetInRange() [7/10]

void ansys::CffConsumer::setDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short *const	data,
		const size_t	dataSize
	)

virtual

◆ setDataOfVariableForSetInRange() [8/10]

void ansys::CffConsumer::setDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const size_t *const	data,
		const size_t	dataSize
	)

virtual

◆ setDataOfVariableForSetInRange() [9/10]

void ansys::CffConsumer::setDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const unsigned char *const	data,
		const size_t	dataSize
	)

virtual

◆ setDataOfVariableForSetInRange() [10/10]

void ansys::CffConsumer::setDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const unsigned int *const	data,
		const size_t	dataSize
	)

virtual

◆ setDataPrecision()

void ansys::CffConsumer::setDataPrecision ( DataPrecisionType ptype )

Sets the precision for solution data.

Parameters

ptype [in] - The precision of the data

See also: DataPrecisionType

◆ setFaceCellZone0Ids()

void ansys::CffConsumer::setFaceCellZone0Ids	(	const ZoneIdType	faceZoneId,
		const ZoneIds &	zoneIds
	)		const

virtual

Set the cell zones adjacent on side 0 of the supplied face zone.

Parameters

faceZoneId	- Face zone for which to set the cell zone adjancencies.
zoneIds	- Cell zones adjacent to side 0 of the face zone.

◆ setFaceCellZone1Ids()

void ansys::CffConsumer::setFaceCellZone1Ids	(	const ZoneIdType	faceZoneId,
		const ZoneIds &	zoneIds
	)		const

virtual

Set the cell zones adjacent on side 1 of the supplied face zone.

Parameters

faceZoneId	- Face zone for which to set the cell zone adjancencies.
zoneIds	- Cell zones adjacent to side 1 of the face zone.

◆ setFaceCountForCell()

void ansys::CffConsumer::setFaceCountForCell	(	const ElemIdType	cellId,
		const short	faceCount
	)		const

virtual

set the face count for single cell

Parameters

cellId	[in] - cell Id
faceCount	[in] - face count of the cell element

◆ setFaceCountsForCellsInRange()

void ansys::CffConsumer::setFaceCountsForCellsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short *const	faceCounts,
		const size_t	dataSize
	)		const

virtual

Set the face counts for several cells.

1) Will set face counts for all cells, whose element id is between minId and maxId 2) The cell element ids are supposed to be continuous in the range

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
faceCounts	[in] - face counts data
dataSize	[in] - data size

◆ setFaceCountsForCellsInZone()

void ansys::CffConsumer::setFaceCountsForCellsInZone	(	const ZoneIdType	zoneId,
		const short *const	faceCounts,
		const size_t	dataSize
	)		const

virtual

set the face counts for all cells in an cells zone

Parameters

zoneId	[in] - edge zone Id
faceCounts	[in] - face counts
dataSize	[in] - data size

◆ setFaceIdsForCell()

void ansys::CffConsumer::setFaceIdsForCell	(	const ElemIdType	cellId,
		const ElemIdType *const	faceIds,
		const size_t	dataSize
	)		const

virtual

set the face ids of single cell

Parameters

cellId	[in] - cell Id
faceIds	[in] - face Ids
dataSize	[in] - data size

◆ setFaceIdsForCellsInRange()

void ansys::CffConsumer::setFaceIdsForCellsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const ElemIdType *const	FaceIds,
		const size_t	dataSize
	)		const

virtual

set the face ids of cells in a range

1) Will set face ids for all cells, whose element id is between minId and maxId 2) The cell ids are supposed to be continuous in the range

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
FaceIds	[in] - face Ids
dataSize	[in] - data size

◆ setFaceIdsForCellsInZone()

void ansys::CffConsumer::setFaceIdsForCellsInZone	(	const ZoneIdType	zoneId,
		const ElemIdType *const	faceIds,
		const size_t	dataSize
	)		const

virtual

set the face ids for all cells in a cell zone

Parameters

zoneId	[in] - cell zone Id
faceIds	[in] - face Ids
dataSize	[in] - data size

◆ setIdsForSetData()

size_t ansys::CffConsumer::setIdsForSetData	(	const ElemIdType *const	setId,
		const size_t	dataSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setIdsForSetInRange()

void ansys::CffConsumer::setIdsForSetInRange	(	const ElemIdType	minIndex,
		const ElemIdType	maxIndex,
		const ElemIdType	minId,
		const ElemIdType	maxId,
		const ElemIdType *const	setId,
		const size_t	dataSize
	)

virtual

◆ setInterfaceDataForFacesInZone() [1/2]

void ansys::CffConsumer::setInterfaceDataForFacesInZone	(	const ZoneIdType	zoneId,
		const double * const	area,
		const size_t	areaSize,
		const double * const	centroid,
		const size_t	centroidSize,
		const size_t * const	pf0Ids,
		const size_t	pf0Size,
		const size_t * const	pf1Ids = `NULL`,
		const size_t	pf1Size = `0`
	)		const

virtual

◆ setInterfaceDataForFacesInZone() [2/2]

void ansys::CffConsumer::setInterfaceDataForFacesInZone	(	const ZoneIdType	zoneId,
		const float * const	area,
		const size_t	areaSize,
		const float * const	centroid,
		const size_t	centroidSize,
		const size_t * const	pf0Ids,
		const size_t	pf0Size,
		const size_t * const	pf1Ids = `NULL`,
		const size_t	pf1Size = `0`
	)		const

virtual

◆ setIOMode()

virtual void ansys::CffConsumer::setIOMode ( IOMode ioMode )

inlinevirtual

◆ setLocalElemIdsInZone()

void ansys::CffConsumer::setLocalElemIdsInZone	(	const ZoneIdType	zoneId,
		const ElemIdType *const	elemIds,
		const size_t	dataSize
	)

virtual

Provide a local element mapping to global element mapping.

When writing a file in serial write mode, the data that will be written will be associated with the element ids provided by the zone information. However, when writing in parallel the may only be provided for part of the zone in which case this function should be provided such that it represents the element ids for which data is being provided.

Parameters

zoneId	[in] - The zone for which data is being provided
elemIds	[in] - The global element ids for the data being provided
dataSize	[in] - The number of element ids provided

See also: setIOMode and ansys::IOMode

◆ setLocationModel()

void ansys::CffConsumer::setLocationModel ( const CffLocationModel * locationModel ) const

Write the location model.

Parameters

locationModel [in] - The location model object to write to the CFF_CASE model.

◆ setMPIComm()

virtual void ansys::CffConsumer::setMPIComm ( void * mpiComm )

inlinevirtual

◆ setNodeCountForCell()

void ansys::CffConsumer::setNodeCountForCell	(	const ElemIdType	cellId,
		const short	nodeCount
	)		const

virtual

set the node count for single cell

Parameters

cellId	[in] - cell Id
nodeCount	[in] - node count of the cell element

◆ setNodeCountForEdge()

void ansys::CffConsumer::setNodeCountForEdge	(	const ElemIdType	edgeId,
		const short	nodeCount
	)		const

virtual

Set the number of nodes that define an edge.

Parameters

edgeId	[in] - The edge
nodeCount	[in] - The number of nodes for the edge

See also: startWritingNodeCountsForEdges, setNodeCountsForEdgesInRange, setNodeCountsForEdgesInZone, setUniformNodeCountForEdgesInZone, setUniformNodeCountForFacesInZone setNodeCountsForEdgesInZone, setUniformNodeCountForEdgesInZone, setUniformNodeCountForFacesInZone endWritingNodeCountsForEdges

◆ setNodeCountForFace()

void ansys::CffConsumer::setNodeCountForFace	(	const ElemIdType	faceId,
		const short	nodeCount
	)		const

virtual

Define the node count for the face supplied.

Parameters

faceId	[in] - The face for which the count is supplied
nodeCount	[in] - The node count of that face

See also: startWritingNodeCOuntsForFaces, setNodeCountsForFacesInRange, setNodeCountsForFacesInZone, setUniformNodeCountForEdgesInRange, setUniformNodeCountForEdgesInZone, endWritingNodeCountsForFaces

◆ setNodeCountsForCellsInRange()

void ansys::CffConsumer::setNodeCountsForCellsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short *const	nodeCounts,
		const size_t	dataSize
	)		const

virtual

Set the node counts for several cells.

1) Will set node counts for all cells, whose element id is between minId and maxId 2) The cell element ids are supposed to be continuous in the range

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
nodeCounts	[in] - node counts data
dataSize	[in] - data size

◆ setNodeCountsForCellsInZone()

void ansys::CffConsumer::setNodeCountsForCellsInZone	(	const ZoneIdType	zoneId,
		const short *const	nodeCounts,
		const size_t	dataSize
	)		const

virtual

set the node counts for all cells in an cell zone

Parameters

zoneId	[in] - edge zone Id
nodeCounts	[in] - node counts
dataSize	[in] - data size

◆ setNodeCountsForEdgesInRange()

void ansys::CffConsumer::setNodeCountsForEdgesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short *const	nodeCounts,
		const size_t	dataSize
	)		const

virtual

Set the number of nodes that define a range of edges.

Parameters

minId	[in] - The first edge in the range
maxId	[in] - The final edge in the range
nodeCounts	[in] - The node counts for all edges in the range
dataSize	[in] - The size of the nodeCounts array

See also: startWritingNodeCountsForEdges, setNodeCountsForEdge, setNodeCountsForEdgesInZone, setUniformNodeCountForEdgesInZone, setUniformNodeCountForFacesInZone endWritingNodeCountsForEdges

◆ setNodeCountsForEdgesInZone()

void ansys::CffConsumer::setNodeCountsForEdgesInZone	(	const ZoneIdType	zoneId,
		const short *const	nodeCounts,
		const size_t	dataSize
	)		const

virtual

Set the number of nodes that define a edge zone.

Parameters

zoneId	[in] - The zone for which counts are supplied
nodeCounts	[in] - The node counts for all edges in the zone
dataSize	[in] - The size of the nodeCounts array

See also: startWritingNodeCountsForEdges, setNodeCountsForEdge, setNodeCountsForEdgesInRange, setUniformNodeCountForEdgesInZone, setUniformNodeCountForFacesInZone endWritingNodeCountsForEdges

◆ setNodeCountsForFacesInRange()

void ansys::CffConsumer::setNodeCountsForFacesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short *const	nodeCounts,
		const size_t	dataSize
	)		const

virtual

Define the node count for the faces in the range supplied.

Note: The range must be continuous and so the number of counts supplied will equal the size of the range

Parameters

minId	[in] - The first face for which counts are supplied
maxId	[in] - The last face for which counts are supplied
nodeCounts	[in] - The node counts
dataSize	[in] - The size of the nodeCounts array

See also: startWritingNodeCountsForFaces, setNodeCountForFace, setNodeCountsForFacesInZone, setUniformNodeCountForEdgesInRange, setUniformNodeCountForEdgesInZone, endWritingNodeCountsForFaces

◆ setNodeCountsForFacesInZone()

void ansys::CffConsumer::setNodeCountsForFacesInZone	(	const ZoneIdType	zoneId,
		const short *const	nodeCounts,
		const size_t	dataSize
	)		const

virtual

Define the node count for the faces in the zone.

Parameters

zoneId	[in] - The zone for which counts are supplied
nodeCounts	[in] - The node counts
dataSize	[in] - The size of the nodeCounts array

See also: startWritingNodeCountsForFaces, setNodeCountForFace, setNodeCountsForFacesInRange, setUniformNodeCountForEdgesInRange, setUniformNodeCountForEdgesInZone, endWritingNodeCountsForFaces

◆ setNodeIdsForCell()

void ansys::CffConsumer::setNodeIdsForCell	(	const ElemIdType	cellId,
		const ElemIdType *const	nodeIds,
		const size_t	dataSize
	)		const

virtual

set the node ids of single cell

Parameters

cellId	[in] - cell Id
nodeIds	[in] - node Ids
dataSize	[in] - data size

◆ setNodeIdsForCellsInRange()

void ansys::CffConsumer::setNodeIdsForCellsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const ElemIdType *const	nodeIds,
		const size_t	dataSize
	)		const

virtual

set the node ids of cells in a range

1) Will set node ids for all cells, whose cell element id is between minId and maxId 2) The cell ids are supposed to be continuous in the range

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
nodeIds	[in] - node Ids
dataSize	[in] - data size

◆ setNodeIdsForCellsInZone()

void ansys::CffConsumer::setNodeIdsForCellsInZone	(	const ZoneIdType	zoneId,
		const ElemIdType *const	nodeIds,
		const size_t	dataSize
	)		const

virtual

set the node ids for all cells in a cell zone

Parameters

zoneId	[in] - cell zone Id
nodeIds	[in] - node Ids
dataSize	[in] - data size

◆ setNodeIdsForEdge()

void ansys::CffConsumer::setNodeIdsForEdge	(	const ElemIdType	edgeId,
		const ElemIdType *const	nodeIds,
		const size_t	dataSize
	)		const

virtual

Provide the ids of the nodes for a single edge.

Parameters

edgeId	[in] - The edge for which nodes are supplied
nodeIds	[in] - The nodes defining the edge
dataSize	[in] - The size of the nodeIds array

Note: dataSize should be the same as the node count previously supplied for the edge being defined

See also: startWritingNodeIdsForEdges\ setNodeIdsForEdgesInRange, setNodeIdsForEdgesInZone, endWritingNodeIdsForEdges

◆ setNodeIdsForEdgesInRange()

void ansys::CffConsumer::setNodeIdsForEdgesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const ElemIdType *const	nodeIds,
		const size_t	dataSize
	)		const

virtual

Provide the ids of the nodes for a range of edges.

Note: The edge range must be continuous

Parameters

minId	[in] - The first edge for which nodes are provided
maxId	[in] - The last edge for which nodes are provided
nodeIds	[in] - The nodes defining each edge
dataSize	[in] - The size of the nodeIds array

See also: startWritingNodeIdsForEdges\ setNodeIdsForEdge, setNodeIdsForEdgesInZone, endWritingNodeIdsForEdges

◆ setNodeIdsForEdgesInZone()

void ansys::CffConsumer::setNodeIdsForEdgesInZone	(	const ZoneIdType	zoneId,
		const ElemIdType *const	nodeIds,
		const size_t	dataSize
	)		const

virtual

Provide the ids of the nodes for all edges in an edge zone.

Parameters

zoneId	[in] - The edge zone for which nodes will be provided
nodeIds	[in] - The nodes for all edges in the zone
dataSize	[in] - The size of the nodeIds array

See also: startWritingNodeIdsForEdges\ setNodeIdsForEdge, setNodeIdsForEdgesInRange, endWritingNodeIdsForEdges

◆ setNodeIdsForFace()

void ansys::CffConsumer::setNodeIdsForFace	(	const ElemIdType	faceId,
		const ElemIdType *const	nodeIds,
		const size_t	dataSize
	)		const

virtual

set the node ids of single face

Parameters

faceId	[in] - face Id
nodeIds	[in] - node Ids
dataSize	[in] - data size

◆ setNodeIdsForFacesInRange()

void ansys::CffConsumer::setNodeIdsForFacesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const ElemIdType *const	nodeIds,
		const size_t	dataSize
	)		const

virtual

set the node ids of faces in a range

1) Will set node ids for all faces, whose face id is between minId and maxId 2) The face ids are supposed to be continuous in the range

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
nodeIds	[in] - node Ids
dataSize	[in] - data size

◆ setNodeIdsForFacesInZone()

void ansys::CffConsumer::setNodeIdsForFacesInZone	(	const ZoneIdType	zoneId,
		const ElemIdType *const	nodeIds,
		const size_t	dataSize
	)		const

virtual

set the node ids for all faces in a face zone

Parameters

zoneId	[in] - face zone Id
nodeIds	[in] - node Ids
dataSize	[in] - data size

◆ setPartitionIdForCell()

void ansys::CffConsumer::setPartitionIdForCell	(	const ElemIdType	cellId,
		const PartitionIdType	partId
	)		const

virtual

set the partition id for single cell

Parameters

cellId	[in] - cell Id
partId	[in] - partition id of the cell element

◆ setPartitionIdsForCellsInRange()

void ansys::CffConsumer::setPartitionIdsForCellsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const PartitionIdType *const	partIds,
		const size_t	dataSize
	)		const

virtual

Set the partition ids for several cells.

1) Will set partition ids for all cells, whose element id is between minId and maxId 2) The cell element ids are supposed to be continuous in the range

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
partIds	[in] - partition ids
dataSize	[in] - data size

◆ setPartitionIdsForCellsInZone()

void ansys::CffConsumer::setPartitionIdsForCellsInZone	(	const ZoneIdType	zoneId,
		const PartitionIdType *const	partIds,
		const size_t	dataSize
	)		const

virtual

set the partition ids for all cells in an cells zone

Parameters

zoneId	[in] - edge zone Id
partIds	[in] - partition ids
dataSize	[in] - data size

◆ setPhaseNames()

bool ansys::CffConsumer::setPhaseNames	(	const PhaseNames &	phaseNames,
		PhaseIds &	phaseIds
	)		const

virtual

Define the set of unique phase names (all existing phase names and associated variables are deleted)

Note: If a phase name already exists it will return the existing phaseId

Parameters

phaseNames	[in] - the phase names to add
phaseIds	[out] - the associated phase ids return [out] - true if phases are defined successfully or false

◆ setPhaseVariablesOfCategory() [1/3]

bool ansys::CffConsumer::setPhaseVariablesOfCategory	(	const ZoneCategory	zoneCategory,
		const VariableIds &	ids
	)		const

virtual

Add the variables in the currently active phase to zones of the category.

Parameters

zoneCategory	[in] of which zone category, the variable ids will be set
ids	[in] variable ids

Returns: - true if operation is successful otherwise false

◆ setPhaseVariablesOfCategory() [2/3]

bool ansys::CffConsumer::setPhaseVariablesOfCategory	(	const ZoneCategory	zoneCategory,
		const VariableNames &	names
	)		const

virtual

Add the variables in the currently active phase to zones of the category.

Parameters

zoneCategory	[in] of which zone category, the variable ids will be set
names	[in] variable name

Returns: - - true if operation is successful otherwise false

◆ setPhaseVariablesOfCategory() [3/3]

bool ansys::CffConsumer::setPhaseVariablesOfCategory	(	const ZoneCategory	zoneCategory,
		const VariableNames &	names,
		VariableIds &	ids
	)		const

virtual

Add the variables in the currently active phase to zones of the category.

Parameters

zoneCategory	[in] of which zone category, the variable ids will be set
names	[in] variable name
ids	[out] variable ids corresponding to the input variable names

Returns: - - true if operation is successful otherwise false

◆ setShadowFaceIdForFace()

void ansys::CffConsumer::setShadowFaceIdForFace	(	const ElemIdType	faceId,
		const ElemIdType	faceShadow
	)		const

virtual

set the shadow face id of single face

Parameters

faceId	[in] - face Id
faceShadow	[in] - shadow face Id

◆ setShadowFaceIdsForFacesInRange()

void ansys::CffConsumer::setShadowFaceIdsForFacesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const ElemIdType *const	faceShadows,
		const size_t	dataSize
	)		const

virtual

Set the shadows face ids of faces in a range.

1) Will set shadows face ids for all faces, whose face id is between minId and maxId 2) The face ids are supposed to be continuous in the range

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
faceShadows	[in] - shadows face ids
dataSize	[in] - data size

◆ setShadowFaceIdsForFacesInZone()

void ansys::CffConsumer::setShadowFaceIdsForFacesInZone	(	const ZoneIdType	zoneId,
		const ElemIdType *const	faceShadows,
		const size_t	dataSize
	)		const

virtual

set the shadows face ids for all faces in a face zone

Parameters

zoneId	[in] - face zone Id
faceShadows	[in] - shadows face ids
dataSize	[in] - data size

◆ setSizeOfVariableForSetInRange() [1/6]

void ansys::CffConsumer::setSizeOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const CountType *const	counts,
		const size_t	dataSize
	)

virtual

◆ setSizeOfVariableForSetInRange() [2/6]

void ansys::CffConsumer::setSizeOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const CountType	count,
		const size_t	dataSize
	)

virtual

◆ setSizeOfVariableForSetInRange() [3/6]

void ansys::CffConsumer::setSizeOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const int *const	counts,
		const size_t	dataSize
	)

virtual

◆ setSizeOfVariableForSetInRange() [4/6]

void ansys::CffConsumer::setSizeOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const int	count,
		const size_t	dataSize
	)

virtual

◆ setSizeOfVariableForSetInRange() [5/6]

void ansys::CffConsumer::setSizeOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const size_t *const	counts,
		const size_t	dataSize
	)

virtual

◆ setSizeOfVariableForSetInRange() [6/6]

void ansys::CffConsumer::setSizeOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const size_t	count,
		const size_t	dataSize
	)

virtual

◆ setSizesAndMinMaxIdsForSet()

void ansys::CffConsumer::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

◆ setTypeForCell()

void ansys::CffConsumer::setTypeForCell	(	const ElemIdType	cellId,
		const CellType	cellType
	)		const

virtual

set the cell type of single cell

Parameters

cellId	[in] - cell Id
cellType	[in] - cell type

◆ setTypesForCellsInRange()

void ansys::CffConsumer::setTypesForCellsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const CellType * const	cellTypes,
		const size_t	dataSize
	)		const

virtual

set the cell element types of cells in a range

1) Will set cell element types for all cells, whose cell element id is between minId and maxId 2) The cell ids are supposed to be continuous in the range

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
cellTypes	[in] - cell element types
dataSize	[in] - data size

◆ setTypesForCellsInZone()

void ansys::CffConsumer::setTypesForCellsInZone	(	const ZoneIdType	zoneId,
		const CellType *const	cellTypes,
		const size_t	dataSize
	)		const

virtual

set the cell element types for all cells in a cell zone

Parameters

zoneId	[in] - cell zone Id
cellTypes	[in] - cell element types
dataSize	[in] - data size

◆ setUniformChildCellCountForCellsInRange()

void ansys::CffConsumer::setUniformChildCellCountForCellsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short	ucc
	)		const

virtual

◆ setUniformChildCellCountForCellsInZone()

void ansys::CffConsumer::setUniformChildCellCountForCellsInZone	(	const ZoneIdType	zoneId,
		const short	ucc
	)		const

virtual

◆ setUniformChildFaceCountForFacesInRange()

void ansys::CffConsumer::setUniformChildFaceCountForFacesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short	ufc
	)		const

virtual

Set a uniformed refined child face count for a face range.

◆ setUniformChildFaceCountForFacesInZone()

void ansys::CffConsumer::setUniformChildFaceCountForFacesInZone	(	const ZoneIdType	zoneId,
		const short	ufc
	)		const

virtual

Set a uniformed refined child face count for all faces in a zone.

◆ setUniformFaceCountForCellsInRange()

void ansys::CffConsumer::setUniformFaceCountForCellsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short	unc
	)		const

virtual

◆ setUniformFaceCountForCellsInZone()

void ansys::CffConsumer::setUniformFaceCountForCellsInZone	(	const ZoneIdType	zoneId,
		const short	unc
	)		const

virtual

◆ setUniformNodeCountForCellsInRange()

void ansys::CffConsumer::setUniformNodeCountForCellsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short	unc
	)		const

virtual

◆ setUniformNodeCountForCellsInZone()

void ansys::CffConsumer::setUniformNodeCountForCellsInZone	(	const ZoneIdType	zoneId,
		const short	unc
	)		const

virtual

◆ setUniformNodeCountForEdgesInRange()

void ansys::CffConsumer::setUniformNodeCountForEdgesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short	unc
	)		const

virtual

Set a uniform node count for all faces in a range.

Parameters

minId	[in] - The first edge in the range
maxId	[in] - The final edge in the range
unc	[in] - The node count for all edges in the range

See also: startWritingNodeCountsForEdges, setNodeCountsForEdge, setNodeCountsForEdgesInRange, setNodeCountForEdgesInZone, setUniformNodeCountForFacesInZone, endWritingNodeCountsForEdges

◆ setUniformNodeCountForEdgesInZone()

void ansys::CffConsumer::setUniformNodeCountForEdgesInZone	(	const ZoneIdType	zoneId,
		const short	unc
	)		const

virtual

Set a uniform node count for all faces in a zone.

Parameters

zoneId	[in] - The edge zone for which the count is provided
unc	[in] - The node count for all edges in the range

See also: startWritingNodeCountsForEdges, setNodeCountsForEdge, setNodeCountsForEdgesInRange, setNodeCountForEdgesInZone, setUniformNodeCountForFacesInRange, endWritingNodeCountsForEdges

◆ setUniformNodeCountForFacesInRange()

void ansys::CffConsumer::setUniformNodeCountForFacesInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short	unc
	)		const

virtual

Set a uniform node count for the faces in a range.

Parameters

minId	[in] - The first face for which counts are supplied
maxId	[in] - The last face for which counts are supplied
unc	[in] - The uniform node count for all faces in the range

See also: startWritingNodeCountsForFaces, setNodeCountForFace, setNodeCountsForFacesInRange, setNodeCountsForFacesInZone, setUniformNodeCountForEdgesInZone, endWritingNodeCountsForFaces

◆ setUniformNodeCountForFacesInZone()

void ansys::CffConsumer::setUniformNodeCountForFacesInZone	(	const ZoneIdType	zoneId,
		const short	unc
	)		const

virtual

Set a uniform node count for the faces in a zone.

Parameters

zoneId	[in] - The zone in which the elements should have the uniform count set
unc	[in] - The uniform node count for all faces zone

See also: startWritingNodeCountsForFaces, setNodeCountForFace, setNodeCountsForFacesInRange, setNodeCountsForFacesInZone, setUniformNodeCountForEdgesInRange, endWritingNodeCountsForFaces

◆ setValuesOfParticleTrackVariable() [1/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableIdType	VarId,
		const char *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

VarId	[in] - specifies the variable by id
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [2/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableIdType	VarId,
		const double *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

VarId	[in] - specifies the variable by id
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [3/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableIdType	VarId,
		const float *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

VarId	[in] - specifies the variable by id
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [4/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableIdType	VarId,
		const int *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

VarId	[in] - specifies the variable by id
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [5/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableIdType	VarId,
		const long *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

VarId	[in] - specifies the variable by id
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [6/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableIdType	VarId,
		const long long *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

VarId	[in] - specifies the variable by id
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [7/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableIdType	VarId,
		const short *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

VarId	[in] - specifies the variable by id
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [8/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableIdType	VarId,
		const size_t *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

VarId	[in] - specifies the variable by id
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [9/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableIdType	VarId,
		const unsigned char *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

VarId	[in] - specifies the variable by id
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [10/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableIdType	VarId,
		const unsigned int *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

VarId	[in] - specifies the variable by id
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [11/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableName &	varName,
		const char *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

varName	[in] - specifies the variable name
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [12/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableName &	varName,
		const double *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

varName	[in] - specifies the variable name
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [13/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableName &	varName,
		const float *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

varName	[in] - specifies the variable name
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [14/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableName &	varName,
		const int *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

varName	[in] - specifies the variable name
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [15/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableName &	varName,
		const long *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

varName	[in] - specifies the variable name
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [16/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableName &	varName,
		const long long *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

varName	[in] - specifies the variable name
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [17/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableName &	varName,
		const short *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

varName	[in] - specifies the variable name
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [18/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableName &	varName,
		const size_t *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

varName	[in] - specifies the variable name
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [19/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableName &	varName,
		const unsigned int *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

varName	[in] - specifies the variable name
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is pa rticle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfParticleTrackVariable() [20/20]

void ansys::CffConsumer::setValuesOfParticleTrackVariable	(	const VariableName &	varName,
		const unsigned char *const	data,
		const size_t	numSteps,
		const size_t	numCol = `1`,
		const bool	asConstant = `false`
	)

virtual

Write variable to chunk.

Parameters

varName	[in] - specifies the variable name
data	[in] - pointer to actual data to write, the data type of data can be unsigned char, char, int, unsigned int, short, float, double, long, long long or size_t
numSteps	[in] - specifies the number of particle track steps. In the file, data fpr each step will be saved in a "row"
numCol	[in] - specifies the number of data for each step. For example, if the variable is particle location in a 3D case, numCol should be 3. If the variable is temperature of that particle, numCol should be 1.
asConstant	[in] - specifies whether the variable changes as a function of track steps or not. For example, for particle id, asConstant should be true, for temperature, asConstant should be false

◆ setValuesOfPhaseVariableForElementsInRange() [1/2]

void ansys::CffConsumer::setValuesOfPhaseVariableForElementsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const double *const	vals,
		const size_t	dataSize
	)		const

virtual

Set the solution data values for all elements in certain range.

1) Will write solution data for all elements, whose element id is between minId and maxId 2) The element ids are supposed to be continuous in the range

Note: The zone of category should have be indicated while calling CffConsumer::startWritingPhaseVariableInZonesOfCategory If the zone category is face zone, the data here should be solution data on face and the minId, maxId should be face Id

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
vals	[in] - actual solution data
dataSize	[in] - data size

◆ setValuesOfPhaseVariableForElementsInRange() [2/2]

void ansys::CffConsumer::setValuesOfPhaseVariableForElementsInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const float *const	vals,
		const size_t	dataSize
	)		const

virtual

Set the solution data values for all elements in certain range.

1) Will write solution data for all elements, whose element id is between minId and maxId 2) The element ids are supposed to be continuous in the range

Note: The zone of category should have be indicated while calling CffConsumer::startWritingPhaseVariableInZonesOfCategory If the zone category is face zone, the data here should be solution data on face and the minId, maxId should be face Id

Parameters

minId	[in] - minimum Id
maxId	[in] - maximum Id
vals	[in] - actual solution data
dataSize	[in] - data size

◆ setValuesOfPhaseVariableForElementsInZone() [1/2]

void ansys::CffConsumer::setValuesOfPhaseVariableForElementsInZone	(	const ZoneIdType	zoneId,
		const double *const	vals,
		const size_t	dataSize
	)		const

virtual

Set the solution data values for all elements in certain range.

Parameters

zoneId	[in] - minimum Id
vals	[in] - actual solution data
dataSize	[in] - data size

◆ setValuesOfPhaseVariableForElementsInZone() [2/2]

void ansys::CffConsumer::setValuesOfPhaseVariableForElementsInZone	(	const ZoneIdType	zoneId,
		const float *const	vals,
		const size_t	dataSize
	)		const

virtual

Set the solution data values for all elements in certain range.

Parameters

zoneId	[in] - minimum Id
vals	[in] - actual solution data
dataSize	[in] - data size

◆ setVariableForSetData() [1/10]

size_t ansys::CffConsumer::setVariableForSetData	(	const char *const	data,
		const size_t	numRow,
		const size_t	numCol,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableForSetData() [2/10]

size_t ansys::CffConsumer::setVariableForSetData	(	const double *const	data,
		const size_t	numRow,
		const size_t	numCol,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableForSetData() [3/10]

size_t ansys::CffConsumer::setVariableForSetData	(	const float *const	data,
		const size_t	numRow,
		const size_t	numCol,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableForSetData() [4/10]

size_t ansys::CffConsumer::setVariableForSetData	(	const int *const	data,
		const size_t	numRow,
		const size_t	numCol,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableForSetData() [5/10]

size_t ansys::CffConsumer::setVariableForSetData	(	const long *const	data,
		const size_t	numRow,
		const size_t	numCol,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableForSetData() [6/10]

size_t ansys::CffConsumer::setVariableForSetData	(	const long long *const	data,
		const size_t	numRow,
		const size_t	numCol,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableForSetData() [7/10]

size_t ansys::CffConsumer::setVariableForSetData	(	const short *const	data,
		const size_t	numRow,
		const size_t	numCol,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableForSetData() [8/10]

size_t ansys::CffConsumer::setVariableForSetData	(	const size_t *const	data,
		const size_t	numRow,
		const size_t	numCol,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableForSetData() [9/10]

size_t ansys::CffConsumer::setVariableForSetData	(	const unsigned char *const	data,
		const size_t	numRow,
		const size_t	numCol,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableForSetData() [10/10]

size_t ansys::CffConsumer::setVariableForSetData	(	const unsigned int *const	data,
		const size_t	numRow,
		const size_t	numCol,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthedDataOfVariableForSetInRange() [1/10]

void ansys::CffConsumer::setVariableLengthedDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const char *const	data,
		const size_t	dataSize
	)

virtual

◆ setVariableLengthedDataOfVariableForSetInRange() [2/10]

void ansys::CffConsumer::setVariableLengthedDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const double *const	data,
		const size_t	dataSize
	)

virtual

◆ setVariableLengthedDataOfVariableForSetInRange() [3/10]

void ansys::CffConsumer::setVariableLengthedDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const float *const	data,
		const size_t	dataSize
	)

virtual

◆ setVariableLengthedDataOfVariableForSetInRange() [4/10]

void ansys::CffConsumer::setVariableLengthedDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const int *const	data,
		const size_t	dataSize
	)

virtual

◆ setVariableLengthedDataOfVariableForSetInRange() [5/10]

void ansys::CffConsumer::setVariableLengthedDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const long *const	data,
		const size_t	dataSize
	)

virtual

◆ setVariableLengthedDataOfVariableForSetInRange() [6/10]

void ansys::CffConsumer::setVariableLengthedDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const long long *const	data,
		const size_t	dataSize
	)

virtual

◆ setVariableLengthedDataOfVariableForSetInRange() [7/10]

void ansys::CffConsumer::setVariableLengthedDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const short *const	data,
		const size_t	dataSize
	)

virtual

◆ setVariableLengthedDataOfVariableForSetInRange() [8/10]

void ansys::CffConsumer::setVariableLengthedDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const size_t *const	data,
		const size_t	dataSize
	)

virtual

◆ setVariableLengthedDataOfVariableForSetInRange() [9/10]

void ansys::CffConsumer::setVariableLengthedDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const unsigned char *const	data,
		const size_t	dataSize
	)

virtual

◆ setVariableLengthedDataOfVariableForSetInRange() [10/10]

void ansys::CffConsumer::setVariableLengthedDataOfVariableForSetInRange	(	const ElemIdType	minId,
		const ElemIdType	maxId,
		const unsigned int *const	data,
		const size_t	dataSize
	)

virtual

◆ setVariableLengthVariableForSetData() [1/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const char *const	data,
		const size_t	dataSize,
		const int *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [2/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const char *const	data,
		const size_t	dataSize,
		const short *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [3/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const char *const	data,
		const size_t	dataSize,
		const size_t *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [4/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const double *const	data,
		const size_t	dataSize,
		const int *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [5/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const double *const	data,
		const size_t	dataSize,
		const short *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [6/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const double *const	data,
		const size_t	dataSize,
		const size_t *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [7/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const float *const	data,
		const size_t	dataSize,
		const int *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [8/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const float *const	data,
		const size_t	dataSize,
		const short *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [9/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const float *const	data,
		const size_t	dataSize,
		const size_t *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [10/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const int *const	data,
		const size_t	dataSize,
		const int *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [11/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const int *const	data,
		const size_t	dataSize,
		const short *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [12/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const int *const	data,
		const size_t	dataSize,
		const size_t *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [13/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const long *const	data,
		const size_t	dataSize,
		const int *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [14/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const long *const	data,
		const size_t	dataSize,
		const short *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [15/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const long *const	data,
		const size_t	dataSize,
		const size_t *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [16/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const long long *const	data,
		const size_t	dataSize,
		const int *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [17/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const long long *const	data,
		const size_t	dataSize,
		const short *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [18/30]

size_t ansys::CffConsumer::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

◆ setVariableLengthVariableForSetData() [19/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const short *const	data,
		const size_t	dataSize,
		const int *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [20/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const short *const	data,
		const size_t	dataSize,
		const short *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [21/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const short *const	data,
		const size_t	dataSize,
		const size_t *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [22/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const size_t *const	data,
		const size_t	dataSize,
		const int *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [23/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const size_t *const	data,
		const size_t	dataSize,
		const short *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [24/30]

size_t ansys::CffConsumer::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

◆ setVariableLengthVariableForSetData() [25/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const unsigned char *const	data,
		const size_t	dataSize,
		const int *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [26/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const unsigned char *const	data,
		const size_t	dataSize,
		const short *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [27/30]

size_t ansys::CffConsumer::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

◆ setVariableLengthVariableForSetData() [28/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const unsigned int *const	data,
		const size_t	dataSize,
		const int *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [29/30]

size_t ansys::CffConsumer::setVariableLengthVariableForSetData	(	const unsigned int *const	data,
		const size_t	dataSize,
		const short *const	size,
		const size_t	sizeSize,
		const size_t	chunkId = `0`
	)

virtual

◆ setVariableLengthVariableForSetData() [30/30]

size_t ansys::CffConsumer::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

◆ setWriting()

void ansys::CffConsumer::setWriting	(	DataClass	dataClass,
		bool	writing
	)

protected

Return whether a file is currently being written.

Parameters

dataClass	[in] - Class of data from which to identify the file.
writing	[in] - true if writable, false otherwise.

See also: startWriting, endWriting

◆ startWriting()

virtual bool ansys::CffConsumer::startWriting ( DataClass dataClass )

inlinevirtual

Reimplemented in ansys::CffFileConsumer.

◆ startWritingCaseSectionCategories()

void ansys::CffConsumer::startWritingCaseSectionCategories	(	const ZoneCategory	zoneCategory,
		const CategoryNames &	name
	)		const

virtual

◆ startWritingCaseSectionDataForCategory()

void ansys::CffConsumer::startWritingCaseSectionDataForCategory	(	const CategoryName &	name,
		const ZoneIds &	zoneIds,
		const PlainDataType	dataType,
		const size_t	numCols
	)		const

virtual

◆ startWritingCell0sForFaces()

void ansys::CffConsumer::startWritingCell0sForFaces ( const ZoneIds & zoneIds ) const

virtual

Start writing cell0 cell ids for faces.

◆ startWritingCell1sForFaces()

void ansys::CffConsumer::startWritingCell1sForFaces ( const ZoneIds & zoneIds ) const

virtual

Start writing cell1 cell ids for faces.

◆ startWritingCells()

void ansys::CffConsumer::startWritingCells ( const ZoneIds & zoneIds ) const

virtual

Start writing cells.

Parameters

zoneIds [in] - The zones for which data will be written.

◆ startWritingChildCellCountsForCells()

void ansys::CffConsumer::startWritingChildCellCountsForCells ( ) const

virtual

◆ startWritingChildCellIdsForCells()

void ansys::CffConsumer::startWritingChildCellIdsForCells ( ) const

virtual

◆ startWritingChildCellsForCells()

void ansys::CffConsumer::startWritingChildCellsForCells ( const ZoneIds & zoneIds ) const

virtual

◆ startWritingChildFaceCountsForFaces()

void ansys::CffConsumer::startWritingChildFaceCountsForFaces ( ) const

virtual

Start writing refined child face counts for faces.

◆ startWritingChildFaceIdsForFaces()

void ansys::CffConsumer::startWritingChildFaceIdsForFaces ( ) const

virtual

Start writing refined child face ids.

◆ startWritingChildFacesForFaces()

void ansys::CffConsumer::startWritingChildFacesForFaces ( const ZoneIds & zoneIds ) const

virtual

Start writing refined face data for faces in specified zones.

◆ startWritingChunkInPartiticleTrackGroup()

void ansys::CffConsumer::startWritingChunkInPartiticleTrackGroup ( const size_t chunkIndex = 0 )

virtual

start writing chunk in particle track group, the input chunkIndex specifies

Parameters

chunkIndex [in] - specify the chunk index If the chunkIndex is not specified, the chunk will be named in style like "chunk1", "chunk2" ..., the number after "chunk" will be incrementally increased for new chunks. It is recommended that user do NOT specify the chunk index if no special needs for that

◆ startWritingCoordinatesForNodes()

void ansys::CffConsumer::startWritingCoordinatesForNodes ( const ZoneIds & zoneIds ) const

virtual

Start writing the coorindinates for nodes.

Parameters

zoneIds [in] - The zones for which coordinates will be provided

See also: setCoordinatesForNode, setCoordinatesForNodesInRange setCoordinatesForNodesInZone, endWritingCoordinatesForNodes

◆ startWritingDataOfVariableForSet()

void ansys::CffConsumer::startWritingDataOfVariableForSet	(	const VariableName &	varName,
		const std::vector< size_t >	numElem,
		const size_t	dim,
		const PlainDataType	type
	)

virtual

◆ startWritingEdges()

void ansys::CffConsumer::startWritingEdges ( const ZoneIds & zoneIds ) const

virtual

Start writing information for elements in edge zones.

Parameters

zoneIds [in] Zones for which data will be provided

See also: startWritingNodesForEdges, endWritingNodesForEdges

◆ startWritingFaceCountsForCells()

void ansys::CffConsumer::startWritingFaceCountsForCells ( ) const

virtual

Start writing count of cell faces.

◆ startWritingFaceIdsForCells()

void ansys::CffConsumer::startWritingFaceIdsForCells ( ) const

virtual

Start writing ids of cell faces.

◆ startWritingFaces()

void ansys::CffConsumer::startWritingFaces ( const ZoneIds & zoneIds ) const

virtual

Start of writing faces.

Parameters

zoneIds [in] - Zones that will be written

See also: endWritingEdges, startWritingNodesForFaces, endWritingNodesForFaces

◆ startWritingFacesForCells()

void ansys::CffConsumer::startWritingFacesForCells ( const ZoneIds & zoneIds ) const

virtual

Start writing cell faces.

◆ startWritingIdsForSet()

void ansys::CffConsumer::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

◆ startWritingIdsForSetData()

void ansys::CffConsumer::startWritingIdsForSetData ( )

virtual

◆ startWritingInterfaceDataForFaces()

void ansys::CffConsumer::startWritingInterfaceDataForFaces	(	const ZoneIds &	zoneIds,
		const std::vector< int > &	hasPf1
	)		const

virtual

◆ startWritingNodeCountsForCells()

void ansys::CffConsumer::startWritingNodeCountsForCells ( ) const

virtual

Start writing counts for cell nodes.

◆ startWritingNodeCountsForEdges()

void ansys::CffConsumer::startWritingNodeCountsForEdges ( ) const

virtual

Start writing the node counts for edge zones.

See also: setNodeCountsForEdge, setNodeCountsForEdgesInRange, setNodeCountsForEdgesInZone, setUniformNodeCountForEdgesInZone, setUniformNodeCountForFacesInZone endWritingNodeCountsForEdges

◆ startWritingNodeCountsForFaces()

void ansys::CffConsumer::startWritingNodeCountsForFaces ( ) const

virtual

Start writing node counts for faces.

See also: setNodeCountForFace, setNodeCountsForFacesInRange, setNodeCountsForFacesInZone, setUniformNodeCountForEdgesInRange, setUniformNodeCountForEdgesInZone, endWritingNodeCountsForFaces

◆ startWritingNodeIdsForCells()

void ansys::CffConsumer::startWritingNodeIdsForCells ( ) const

virtual

Start writing ids for cell nodes.

◆ startWritingNodeIdsForEdges()

void ansys::CffConsumer::startWritingNodeIdsForEdges ( ) const

virtual

Start writing the node ids for edges.

See also: setNodeIdsForEdge, setNodeIdsForEdgesInRange, setNodeIdsForEdgesInZone, endWritingNodeIdsForEdges

◆ startWritingNodeIdsForFaces()

void ansys::CffConsumer::startWritingNodeIdsForFaces ( ) const

virtual

Start writing faces node ids.

◆ startWritingNodes()

void ansys::CffConsumer::startWritingNodes ( const ZoneIds & zoneIds ) const

virtual

Start writing nodes.

Parameters

zoneIds [in] - The zones for which node data will be provided

See also: endWritingNodes

◆ startWritingNodesForCells()

void ansys::CffConsumer::startWritingNodesForCells ( const ZoneIds & zoneIds ) const

virtual

Start writing cell nodes.

Parameters

zoneIds [in] - The cell zones for which nodes will be provided.

◆ startWritingNodesForEdges()

void ansys::CffConsumer::startWritingNodesForEdges ( const ZoneIds & zoneIds ) const

virtual

Start writing nodes for edges within specified zones.

Parameters

zoneIds [in] - Zones for which nodes will be provided

Note: This function must be called before writing node counts or node ids for any edge.

See also: startWritingNodeCountsForEdges, endWritingNodeCountsForEdges, startWritingNodeIdsForEdges, endWritingNodeIdsForEdges

◆ startWritingNodesForFaces()

void ansys::CffConsumer::startWritingNodesForFaces ( const ZoneIds & zoneIds ) const

virtual

Start writing faces nodes.

Parameters

zoneIds [in] - Zones with nodes

See also: startWritingNodeCountsForFaces, endWritingNodeCountsForFaces, startWritingNodeIdsForFaces, endWritingNodeIdsForFaces, endWritingNodesForFaces

◆ startWritingParticleTracks()

bool ansys::CffConsumer::startWritingParticleTracks	(	const PhaseIdType	phaseId = `-1`,
		const MeshIdType	meshId = `-1`,
		const TargetCategory	target = `TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN`,
		const PartitionIdType	partition = `-1`
	)

virtual

Start write particle tracks under phase specified by phaseId in the mesh set specified by mesh Id, target and partition.

Parameters

phaseId	[in] - The phase id to which particle track will be added
meshId	[in] - The mesh id to which particle track will be added
target	[in] - The target category which particle track will be added
partition	[in] - The partition id to which particle track will be added, only applicable when target is PARTITION_POST

◆ startWritingPartiticleTrackGroup()

void ansys::CffConsumer::startWritingPartiticleTrackGroup ( const std::string & name = "" )

virtual

Start writing particle track group.

Parameters

name	[in] - groups name

◆ startWritingPartitionIdsForCells()

void ansys::CffConsumer::startWritingPartitionIdsForCells	(	const ZoneIds &	zoneIds,
		const int	numPartitions
	)		const

virtual

Start writing partition ids for cells.

◆ startWritingPhase()

void ansys::CffConsumer::startWritingPhase ( const PhaseIdType phaseId = 1 ) const

virtual

Start writing a phase.

Parameters

phaseId [in] - phase id

◆ startWritingPhaseVariableInZonesOfCategory() [1/2]

void ansys::CffConsumer::startWritingPhaseVariableInZonesOfCategory	(	const ZoneCategory	zoneCategory,
		const VariableIdType	varId,
		ZoneIds &	zoneIds,
		const size_t	numCols
	)		const

virtual

Start writing data for certain variable.

Parameters

zoneCategory	[in] to which zone category, the data will be written into
varId	[in] variable id, indicating which variable to write
zoneIds	[in] zone ids, indicating all zones that has data for the variable.
numCols	[in] number data on each element, for example, if the variable is temperature, it should be 1, if the variable is velocity in 3D, it should be 3

◆ startWritingPhaseVariableInZonesOfCategory() [2/2]

void ansys::CffConsumer::startWritingPhaseVariableInZonesOfCategory	(	const ZoneCategory	zoneCategory,
		const VariableName &	varName,
		ZoneIds &	zoneIds,
		const size_t	numCols
	)		const

virtual

Start writing data for certain variable.

Parameters

zoneCategory	[in] to which zone category, the data will be written into
varName	[in] variable name, indicating which variable to write
zoneIds	[in] zone ids, indicating all zones that has data for the variable.
numCols	[in] number data on each element, for example, if the variable is temperature, it should be 1, if the variable is velocity in 3D, it should be 3

◆ startWritingSet()

void ansys::CffConsumer::startWritingSet	(	const DataClass	dataClass,
		const ZoneCategory	cat,
		const std::string &	setName
	)

virtual

◆ startWritingSetData()

void ansys::CffConsumer::startWritingSetData	(	const DataClass	dataClass,
		const ZoneCategory	cat,
		const std::string &	setName
	)

virtual

◆ startWritingShadowFaceIdsForFaces()

void ansys::CffConsumer::startWritingShadowFaceIdsForFaces ( const ZoneIds & zoneIds ) const

virtual

Start writing shadow faces of faces.

◆ startWritingSizeOfVariableForSet()

void ansys::CffConsumer::startWritingSizeOfVariableForSet	(	const VariableName &	varName,
		const std::vector< size_t >	numElem,
		const PlainDataType	dataType = `PlainDataType::CFF_DATATYPE_SHORT`
	)

virtual

◆ startWritingTimeLevel()

void ansys::CffConsumer::startWritingTimeLevel ( const TimeLevelType timeLevel = CffLatestTimeLevel ) const

◆ startWritingTypesForCells()

void ansys::CffConsumer::startWritingTypesForCells	(	const ZoneIds &	zoneIds,
		const std::vector< CellType > &	cellType
	)		const

virtual

Start writing cells types.

◆ startWritingVariableForSetData()

void ansys::CffConsumer::startWritingVariableForSetData ( const VariableName & varName )

virtual

◆ startWritingVariableLengthedDataOfVariableForSet()

void ansys::CffConsumer::startWritingVariableLengthedDataOfVariableForSet	(	const VariableName &	varName,
		const PlainDataType	type
	)

virtual

◆ startWritingVariableLengthVariableForSetData()

void ansys::CffConsumer::startWritingVariableLengthVariableForSetData ( const VariableName & varName )

virtual

◆ startWritingZonesOfCategory()

void ansys::CffConsumer::startWritingZonesOfCategory ( const ZoneCategory zoneCt ) const

virtual

Start writing solution data for zones of certain category.

Solution data can be associated with either cell elements or face elements or nodes. It is up to the solver where the solution data will be. So so need to save data on all zone categories. For example, Fluent saves solution data on face center and cell center, no solution data associated with nodes.

Parameters

zoneCt [in] to which zone category, the data will be written into

◆ writeMeshAttributes()

void ansys::CffConsumer::writeMeshAttributes ( ) const

virtual

Write the global mesh size attributes and units to the active mesh.

When the mesh size and units are set using setMeshSize or setMeshUnits the API keeps this information in memory until all attributes have been supplied.

This function may be called explicitly at any time but will be called automatically when writing is terminated with endWriting

See also: setMeshSize, setMeshUnits, endWriting

◆ writeMeshSize()

void ansys::CffConsumer::writeMeshSize ( ) const

DEPRECATED: This function is now deprecated in favor of writeMeshAttributes and may be removed in a future release.

See also: writeMeshAttributes

◆ writeOtherDataForSet() [1/10]

void ansys::CffConsumer::writeOtherDataForSet	(	const VariableName &	varName,
		const char *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSet() [2/10]

void ansys::CffConsumer::writeOtherDataForSet	(	const VariableName &	varName,
		const double *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSet() [3/10]

void ansys::CffConsumer::writeOtherDataForSet	(	const VariableName &	varName,
		const float *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSet() [4/10]

void ansys::CffConsumer::writeOtherDataForSet	(	const VariableName &	varName,
		const int *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSet() [5/10]

void ansys::CffConsumer::writeOtherDataForSet	(	const VariableName &	varName,
		const long *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSet() [6/10]

void ansys::CffConsumer::writeOtherDataForSet	(	const VariableName &	varName,
		const long long *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSet() [7/10]

void ansys::CffConsumer::writeOtherDataForSet	(	const VariableName &	varName,
		const short *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSet() [8/10]

void ansys::CffConsumer::writeOtherDataForSet	(	const VariableName &	varName,
		const size_t *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSet() [9/10]

void ansys::CffConsumer::writeOtherDataForSet	(	const VariableName &	varName,
		const unsigned char *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSet() [10/10]

void ansys::CffConsumer::writeOtherDataForSet	(	const VariableName &	varName,
		const unsigned int *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSetData() [1/10]

void ansys::CffConsumer::writeOtherDataForSetData	(	const VariableName &	varName,
		const char *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSetData() [2/10]

void ansys::CffConsumer::writeOtherDataForSetData	(	const VariableName &	varName,
		const double *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSetData() [3/10]

void ansys::CffConsumer::writeOtherDataForSetData	(	const VariableName &	varName,
		const float *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSetData() [4/10]

void ansys::CffConsumer::writeOtherDataForSetData	(	const VariableName &	varName,
		const int *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSetData() [5/10]

void ansys::CffConsumer::writeOtherDataForSetData	(	const VariableName &	varName,
		const long *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSetData() [6/10]

void ansys::CffConsumer::writeOtherDataForSetData	(	const VariableName &	varName,
		const long long *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSetData() [7/10]

void ansys::CffConsumer::writeOtherDataForSetData	(	const VariableName &	varName,
		const short *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSetData() [8/10]

void ansys::CffConsumer::writeOtherDataForSetData	(	const VariableName &	varName,
		const size_t *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSetData() [9/10]

void ansys::CffConsumer::writeOtherDataForSetData	(	const VariableName &	varName,
		const unsigned char *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeOtherDataForSetData() [10/10]

void ansys::CffConsumer::writeOtherDataForSetData	(	const VariableName &	varName,
		const unsigned int *const	data,
		const size_t	numCols,
		const size_t	numRows
	)

virtual

◆ writeSetting()

void ansys::CffConsumer::writeSetting	(	CffSetting &	setting,
		const std::string &	key = `"Common"`,
		DataClass	dataClass = `DataClass::CFF_CASE`,
		const std::string &	rootName = `CffBase::_defaultSettingsPath`
	)		const

virtual

Write a settings object to CFF consumer.

Parameters

setting	[in] - The settings value stored in a settings object
key	[in] - The settings key
dataClass	[in] - Whether the setting is written to the case of results data
rootName	[in] - The path under which the setting will be written

◆ writeSettingStrings()

void ansys::CffConsumer::writeSettingStrings	(	const std::vector< std::pair< std::string, std::string > > &	settings,
		DataClass	dataClass = `DataClass::CFF_CASE`,
		const std::string &	rootName = `CffBase::_defaultSettingsPath`
	)		const

virtual

Write settings to the CFF consumer.

Parameters

settings	[in] - Each pair represents key and value
dataClass	[in] - Whether the setting is written to the case of results data
rootName	[in] - The path under which the setting will be written

◆ writeStringDataForSet()

void ansys::CffConsumer::writeStringDataForSet	(	const VariableName &	varName,
		const std::string &	data
	)

virtual

◆ writeStringDataForSetData()

void ansys::CffConsumer::writeStringDataForSetData	(	const VariableName &	varName,
		const std::string &	data
	)

virtual

ansys::CffConsumer Class Reference

Public Member Functions

Protected Member Functions

Data Precision/

DEPRECATED Set Data functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CffConsumer()

◆ ~CffConsumer()

Member Function Documentation

◆ addPhaseName()

◆ addPhaseNames()

◆ addPhaseVariable() [1/3]

◆ addPhaseVariable() [2/3]

◆ addPhaseVariable() [3/3]

◆ addStringAttribute()

◆ cacheLocationModelState()

◆ endWriting()

◆ endWritingCaseSectionCategories()

◆ endWritingCaseSectionDataForCategory()

◆ endWritingCell0sForFaces()

◆ endWritingCell1sForFaces()

◆ endWritingCells()

◆ endWritingChildCellCountsForCells()

◆ endWritingChildCellIdsForCells()

◆ endWritingChildCellsForCells()

◆ endWritingChildFaceCountsForFaces()

◆ endWritingChildFaceIdsForFaces()

◆ endWritingChildFacesForFaces()

◆ endWritingChunkInPartiticleTrackGroup()

◆ endWritingCoordinatesForNodes()

◆ endWritingDataOfVariableForSet()

◆ endWritingEdges()

◆ endWritingFaceCountsForCells()

◆ endWritingFaceIdsForCells()

◆ endWritingFaces()

◆ endWritingFacesForCells()

◆ endWritingIdsForSet()

◆ endWritingIdsForSetData()

◆ endWritingInterfaceDataForFaces()

◆ endWritingNodeCountsForCells()

◆ endWritingNodeCountsForEdges()

◆ endWritingNodeCountsForFaces()

◆ endWritingNodeIdsForCells()

◆ endWritingNodeIdsForEdges()

◆ endWritingNodeIdsForFaces()

◆ endWritingNodes()

◆ endWritingNodesForCells()

◆ endWritingNodesForEdges()

◆ endWritingNodesForFaces()

◆ endWritingParticleTracks()

◆ endWritingPartiticleTrackGroup()

◆ endWritingPartitionIdsForCells()

◆ endWritingPhase()

◆ endWritingPhaseVariableInZonesOfCategory()

◆ endWritingSet()

◆ endWritingSetData()

◆ endWritingShadowFaceIdsForFaces()

◆ endWritingSizeOfVariableForSet()

◆ endWritingTimeLevel()

◆ endWritingTypesForCells()

◆ endWritingVariableForSetData()

◆ endWritingVariableLengthedDataOfVariableForSet()

◆ endWritingVariableLengthVariableForSetData()

◆ endWritingZonesOfCategory()

◆ getDataPrecision()

◆ getLastLogIndex()

◆ inheritVariableAttributes() [1/2]

◆ inheritVariableAttributes() [2/2]

◆ isWriting()

◆ isWritingData()

◆ log()

◆ setAttributeValueOfPhase() [1/3]

◆ setAttributeValueOfPhase() [2/3]

◆ setAttributeValueOfPhase() [3/3]

◆ setAttributeValueOfPhaseVariable() [1/3]

◆ setAttributeValueOfPhaseVariable() [2/3]

◆ setAttributeValueOfPhaseVariable() [3/3]

◆ setCaseSectionDataForElementsInRange()