Skip to main content

Common Fluids Format 2026 R1

ansys::CffProvider Class Reference

Last update: 24.03.2026

Class that provides functions to access data stored 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 will be returned according to the rules defined in the CFF DataModels. More...

#include "CffInterface/CffProvider.hpp"

Inheritance diagram for ansys::CffProvider:
ansys::CffBaseansys::CffVersionansys::CffFileProvider

Public Member Functions

 CffProvider ()
 Constructor. More...
 
virtual ~CffProvider ()
 Destructor. More...
 
Solution Model Variable Naming Controls
virtual void setVariableTarget (const VariableTarget &target)
 Sets the target variable naming convention. More...
 
virtual void setVariableRecipeProvider (CffVariableRecipeProvider *vrp)
 Function allowing a user of the API to provide a Variable Recipe Provider that interprets data in a particular way. More...
 
Data Caching/Partial Data Controls
virtual void setSkipReadZoneTopology (bool skip)
 Set whether mesh zone to mesh zone topology topology should be constructed when the case data is read. It should be called prior to calling ansys::CffProvider::startReading. More...
 
virtual void setHeavyDataCacheMode (const DataCacheMode cacheMode)
 Set whether heavy weight data is cached within the API when read from the database. This function should be called prior to ansys::CffProvider::startReading. More...
 
Settings
virtual void setReadAllSettings (bool readAllSettings)
 Turn on whether settings are read into a Ansys Common Fluids Settings Data Model. More...
 
virtual void setKeyWordsForSettingsToBeRead (const std::vector< std::string > &dsNames, const std::vector< std::vector< std::string > > &settings)
 Limit the key words to be read into a Ansys Common Fluids Settings Data Model. More...
 
virtual void getSettingsKeys (DataClass dataClass, std::vector< std::string > &keys) const
 Return the keys that are available in the Physics Data Model. More...
 
CffVariant getSettings (const DataClass type, const std::string &key, const PhaseIdType phaseId=1) const
 Return the value as a variable for a specific key in the Ansys Common Fluids Settings Data Model. More...
 
virtual void getSettingString (DataClass dataClass, const std::string &datasetName, std::string &contents, const std::string &path="") const
 Read settings from a data set as text. More...
 
virtual CffSetting getSetting (const std::string &key="Common", DataClass dataClass=DataClass::CFF_CASE, const std::string &rootName=CffBase::_defaultSettingsPath) const
 Read contents of a settings data set as a ansys::CffSetting object. More...
 
virtual void dump (std::string fileName="settings.xml") const
 Dump all setting key/value pairs to a file. More...
 
virtual void print (bool objectOnly=true) const
 Dump all setting key/value pairs to standard out. More...
 
Meshes
virtual bool hasMeshId (MeshIdType) const
 Determine whether a specific mesh exists. More...
 
virtual MeshIds availableMeshIds (DataClass dc=DataClass::CFF_CASE) const
 Obtain the complete list of mesh Identifiers available. More...
 
Targets
bool hasTarget (TargetCategory target) const
 Determine whether the any mesh can be read using the target category. More...
 
TargetCategories availableTargets () const
 Obtain the complete list of targets available. More...
 
virtual bool hasTarget (MeshIdType, TargetCategory) const
 Determine whether a specified mesh can be read using the target category. More...
 
virtual TargetCategories availableTargets (MeshIdType meshId, DataClass dc=DataClass::CFF_CASE) const
 Obtain the complete list of targets available for a specific mesh identifier. More...
 
Partitions
bool hasPartition (PartitionIdType) const
 Query if the partition exists for any mesh. More...
 
int getPartitionCount () const
 Query the global number of partitions available. More...
 
PartitionIds availablePartitionIds () const
 Obtain the complete list of partitions available. More...
 
virtual bool hasPartition (MeshIdType, PartitionIdType) const
 Query if the partition exists for specific mesh. More...
 
virtual int getPartitionCount (MeshIdType) const
 Query the number of partitions available for a specific mesh. More...
 
virtual PartitionIds availablePartitionIds (MeshIdType meshId, DataClass dc=DataClass::CFF_CASE) const
 Obtain the complete list of partitions available for a specific mesh identifier. More...
 
virtual void startReadingPartitionIdsForCells (ZoneIds &) const
 
virtual int getPartitionCountForZone (const ZoneIdType zoneId) const
 
virtual PartitionIdType getPartitionIdForCell (const ElemIdType cellId) const
 
virtual size_t getPartitionIdsForCellsInRange (const ElemIdType, const ElemIdType, PartitionIdType *const partIds, const size_t) const
 
virtual size_t getPartitionIdsForCellsInZone (const ZoneIdType, PartitionIdType *const partIds, const size_t) const
 
virtual void endReadingPartitionIdsForCells () const
 
Node Zones
virtual void startReadingCoordinatesForNodes (ZoneIds &zoneIds) const
 Determine the node zones for which coordinates have been defined and prepare to read the coordinates for those zones. More...
 
virtual size_t getCoordinatesForNode (const ElemIdType nodeId, float *const coord, const size_t) const
 Obtain the coordinates for a specific node. More...
 
virtual size_t getCoordinatesForNodesInRange (const ElemIdType minid, const ElemIdType maxId, float *const coords, const size_t) const
 Obtain the coordinates for a node range. More...
 
virtual size_t getCoordinatesForNodesInZone (const ZoneIdType zoneId, float *const coords, const size_t) const
 Obtain the coordinates for all nodes within a zone. More...
 
virtual size_t getCoordinatesForNode (const ElemIdType nodeId, double *const coord, const size_t) const
 Obtain the coordinates for a specific node. More...
 
virtual size_t getCoordinatesForNodesInRange (const ElemIdType minid, const ElemIdType maxId, double *const coords, const size_t) const
 Obtain the coordinates for a node range. More...
 
virtual size_t getCoordinatesForNodesInZone (const ZoneIdType zoneId, double *const coords, const size_t) const
 Obtain the coordinates for all nodes within a zone. More...
 
virtual void endReadingCoordinatesForNodes () const
 Finish reading coordinates for nodes. More...
 
Edge Zones
virtual void startReadingNodesForEdges (ZoneIds &zoneIds) const
 
virtual void startReadingNodeCountsForEdges () const
 
virtual bool hasUniformNodeCountForEdgesInRange (const ElemIdType minId, const ElemIdType maxId, short *const uenc) const
 
virtual bool hasUniformNodeCountForEdgesInZone (const ZoneIdType zoneId, short *const uenc) const
 
virtual short getNodeCountForEdge (const ElemIdType edgeId) const
 
virtual size_t getNodeCountsForEdgesInRange (const ElemIdType, const ElemIdType, short *const, const size_t) const
 
virtual size_t getNodeCountsForEdgesInZone (const ZoneIdType zoneId, short *const fenc, const size_t) const
 
virtual void endReadingNodeCountsForEdges () const
 
virtual void startReadingNodeIdsForEdges () const
 
virtual size_t getNodeIdsForEdge (const ElemIdType edgeId, ElemIdType *const enid, const size_t) const
 
virtual size_t getNodeIdsForEdgesInRange (const ElemIdType, const ElemIdType, ElemIdType *const, const size_t) const
 
virtual size_t getNodeIdsForEdgesInZone (const ZoneIdType, ElemIdType *const, const size_t) const
 
virtual void endReadingNodeIdsForEdges () const
 
virtual void endReadingNodesForEdges () const
 
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 startReadingNodesForFaces (ZoneIds &zoneIds) const
 Determine the face zones for which nodes have been defined and prepare to read the nodes for those zones. More...
 
virtual void startReadingNodeCountsForFaces () const
 Start reading the face node counts. More...
 
virtual bool hasUniformNodeCountForFacesInRange (const ElemIdType minId, const ElemIdType maxId, short *const ufnc) const
 Query whether all faces in the face range are defined using a uniform node count. i.e. are all the same type. More...
 
virtual bool hasUniformNodeCountForFacesInZone (const ZoneIdType zoneId, short *const ufnc) const
 Query whether all faces in the face zone are defined using a uniform node count. i.e. are all the same type. More...
 
virtual short getNodeCountForFace (const ElemIdType faceId) const
 Get the node count for a sepcific face. More...
 
virtual size_t getNodeCountsForFacesInRange (const ElemIdType, const ElemIdType, short *const, const size_t) const
 Get the node counts for a range of faces. More...
 
virtual size_t getNodeCountsForFacesInZone (const ZoneIdType zoneId, short *const fnc, const size_t) const
 Get the node counts for all faces within a face zone. More...
 
virtual void endReadingNodeCountsForFaces () const
 Finish reading the face node counts. More...
 
virtual void startReadingNodeIdsForFaces () const
 Start reading the face nodes. More...
 
virtual size_t getNodeIdsForFace (const ElemIdType faceId, ElemIdType *const fnid, const size_t) const
 Get the node identifiers for a specific face. More...
 
virtual size_t getNodeIdsForFacesInRange (const ElemIdType, const ElemIdType, ElemIdType *const, const size_t) const
 Get the node identifiers for a range of faces. More...
 
virtual size_t getNodeIdsForFacesInZone (const ZoneIdType, ElemIdType *const, const size_t) const
 Get the node identifiers for a all faces within a face zone. More...
 
virtual void endReadingNodeIdsForFaces () const
 Finish reading the node identifiers for faces. More...
 
virtual void endReadingNodesForFaces () const
 Finish reading the face node data. More...
 
Cell Parents of Faces

Any given mesh face in a model will have either one or two cell parents. The cell on the first side is termed c0, the cell on the other side is termed c1. In general c0 will always exist but c1 may not.

The consistency of the node indices' order must be handled by the CFF consumer application. The standard order is the right-hand rule: if you curl the fingers of your right hand in the order of the nodes, your thumb will point toward c1. Note that Fluent and Fluent Meshing written CFF case files use the face-node reversed right-hand rule: if you curl the fingers of your right hand in the order of the nodes, your thumb will point toward c0.

In order to read the cell parents for a specific face, specified face range or all faces in a face zone the following group of functions must be called. In this example the code is reading the cells on side 0 (c0) for all faces for the first zone that contains faces with c0 data.

// Create the provider
ansys::CffProvider* provider = ...;
provider->startReading(ansys::DataClass::CFF_CASE);

// Obtain the zones containing c0 parent cells ansys::ZoneIds faceZones; provider->startReadingCell0sForFaces(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);

// Allocate the memory to store a cell 0 per face in the zone. ansys::ElemIdType* parents = new ansys::ElemIdType[sz]; provider->getCell0sFacesInZone(faceZones[0], parents, sz);

// Process face parents read

// End reading cell0s provider->endReadingCell0ssForFaces(); // End reading case provider->endReading(ansys::DataClass::CFF_CASE);

virtual void startReadingCell0sForFaces (ZoneIds &zoneIds) const
 Start reading the cell 0 parents. More...
 
virtual ElemIdType getCell0ForFace (const ElemIdType faceId) const
 Obtain cell 0 parent for specified face. More...
 
virtual size_t getCell0sForFacesInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const cell0Id, const size_t) const
 Obtain cell 0 parents for all faces within a face range. More...
 
virtual size_t getCell0sForFacesInZone (const ZoneIdType zoneId, ElemIdType *const cell0Id, const size_t) const
 Obtain cell 0 parents for all faces in zone. More...
 
virtual void endReadingCell0sForFaces () const
 Finish reading the cell 0 parents. More...
 
virtual void startReadingCell1sForFaces (ZoneIds &zoneIds) const
 Start reading the cell 1 parents. More...
 
virtual ElemIdType getCell1ForFace (const ElemIdType faceId) const
 Obtain cell 1 parent for specified face. More...
 
virtual size_t getCell1sForFacesInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const cell1, const size_t) const
 Obtain cell 1 parents for all faces within a range. More...
 
virtual size_t getCell1sForFacesInZone (const ZoneIdType zoneId, ElemIdType *const fc1, const size_t) const
 Obtain cell 1 parents for all faces in zone. More...
 
virtual void endReadingCell1sForFaces () const
 Finish reading the cell 1 parents. More...
 
Shadow Faces
virtual void startReadingShadowFaceIdsForFaces (ZoneIds &zoneIds) const
 
virtual ElemIdType getShadowFaceIdForFace (const ElemIdType faceId) const
 
virtual size_t getShadowFaceIdsForFacesInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const shadowFaces, const size_t) const
 
virtual size_t getShadowFaceIdsForFacesInZone (const ZoneIdType zoneId, ElemIdType *const shadowFaces, const size_t) const
 
virtual void endReadingShadowFaceIdsForFaces () const
 
Interface Data
virtual void startReadingInterfaceDataForFaces (ZoneIds &, std::vector< int > &) const
 
virtual size_t getInterfaceDataForFace (const ElemIdType, double *const, const size_t, double *const, const size_t, size_t *const pf0, size_t *const =NULL) const
 
virtual size_t getInterfaceDataForFacesInZone (const ZoneIdType zoneId, double *const, const size_t, double *const, const size_t, size_t *const, const size_t, size_t *const =NULL, const size_t=0) const
 
virtual size_t getInterfaceDataForFace (const ElemIdType, float *const, const size_t, float *const, const size_t, size_t *const pf0, size_t *const =NULL) const
 
virtual size_t getInterfaceDataForFacesInZone (const ZoneIdType zoneId, float *const, const size_t, float *const, const size_t, size_t *const, const size_t, size_t *const =NULL, const size_t=0) const
 
virtual void endReadingInterfaceDataForFaces () const
 
Face Zone Refinement (Child Faces)
virtual void startReadingChildFacesForFaces (ZoneIds &) const
 
virtual void startReadingChildFaceCountsForFaces () const
 
virtual short getChildFaceCountForFace (const ElemIdType faceId) const
 
virtual size_t getChildFaceCountsForFacesInRange (const ElemIdType, const ElemIdType, short *const, const size_t) const
 
virtual size_t getChildFaceCountsForFacesInZone (const ZoneIdType, short *const, const size_t) const
 
virtual void endReadingChildFaceCountsForFaces () const
 
virtual void startReadingChildFaceIdsForFaces () const
 
virtual size_t getChildFaceIdsForFace (const ElemIdType faceId, ElemIdType *const fcid, const size_t) const
 
virtual size_t getChildFaceIdsForFacesInRange (const ElemIdType, const ElemIdType, ElemIdType *const, const size_t) const
 
virtual size_t getChildFaceIdsForFacesInZone (const ZoneIdType, ElemIdType const, const size_t) const
 
virtual void endReadingChildFaceIdsForFaces () const
 
virtual void endReadingChildFacesForFaces () const
 
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 startReadingTypesForCells (ZoneIds &) const
 Determine the cell zones for which cell types have been defined and prepare to read the cell types for those zones. More...
 
virtual bool hasUniformTypeForCellsInZone (const ZoneIdType zoneId, CellType *const) const
 Query whether all cells in the cell zone have the same cell type. More...
 
virtual CellType getTypeForCell (const ElemIdType cellId) const
 Query the type for a cell. More...
 
virtual size_t getTypesForCellsInRange (const ElemIdType, const ElemIdType, CellType *const, const size_t) const
 Obtain the types of all cells in a range. More...
 
virtual size_t getTypesForCellsInZone (const ZoneIdType, CellType const, const size_t) const
 Obtain the types of all cells in a cell zone. More...
 
virtual void endReadingTypesForCells () const
 Finish reading the types of cells. More...
 
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 startReadingNodesForCells (ZoneIds &zoneIds) const
 Determine the cell zones for which nodes have been defined and prepare to read the nodes for those zones. More...
 
virtual void startReadingNodeCountsForCells () const
 Start reading the cell node counts. More...
 
virtual bool hasUniformNodeCountForCellsInZone (const ZoneIdType zoneId, short *const ucnc) const
 Query whether all cells in the cell zone are defined using a uniform node count. More...
 
virtual short getNodeCountForCell (const ElemIdType cellId) const
 Get the node count for a sepcific cell. More...
 
virtual size_t getNodeCountsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, short *const cnc, const size_t) const
 Get the node counts for a range of cells. More...
 
virtual size_t getNodeCountsForCellsInZone (const ZoneIdType zoneId, short *const cnc, const size_t) const
 Get the node counts for all cells within a cell zone. More...
 
virtual void endReadingNodeCountsForCells () const
 Finish reading the cell node counts. More...
 
virtual void startReadingNodeIdsForCells () const
 Start reading the node identifiers for cells. More...
 
virtual size_t getNodeIdsForCell (const ElemIdType cellId, ElemIdType *const cnid, const size_t) const
 Get the node identifiers for a specific cell. More...
 
virtual size_t getNodeIdsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const cnid, const size_t) const
 Get the node identifiers for a range of cells. More...
 
virtual size_t getNodeIdsForCellsInZone (const ZoneIdType zoneId, ElemIdType *const cnid, const size_t) const
 Get the node identifiers for all cells within a cell zone. More...
 
virtual void endReadingNodeIdsForCells () const
 Finish reading the node identifiers for cells. More...
 
virtual void endReadingNodesForCells () const
 Finish reading the cell node. More...
 
Cell/Faces
Note
These functions should only be used for accessing the faces of Polyhedral Cells in a CFF Post Data Model
virtual void startReadingFacesForCells (ZoneIds &zoneIds) const
 
virtual void startReadingFaceCountsForCells () const
 
virtual bool hasUniformFaceCountForCellsInZone (const ZoneIdType zoneId, short *const ucfc) const
 
virtual short getFaceCountForCell (const ElemIdType cellId) const
 
virtual size_t getFaceCountsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, short *const cfc, const size_t dataSize) const
 
virtual size_t getFaceCountsForCellsInZone (const ZoneIdType zoneId, short *const cfc, const size_t) const
 
virtual void endReadingFaceCountsForCells () const
 
virtual void startReadingFaceIdsForCells () const
 
virtual size_t getFaceIdsForCell (const ElemIdType cellId, ElemIdType *const cfid, const size_t dataSize) const
 
virtual size_t getFaceIdsForCellsInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const cfid, const size_t dataSize) const
 
virtual size_t getFaceIdsForCellsInZone (const ZoneIdType zoneId, ElemIdType *const cfid, const size_t) const
 
virtual void endReadingFaceIdsForCells () const
 
virtual void endReadingFacesForCells () const
 
Cell Refinement (Child Cells )
virtual void startReadingChildCellsForCells (ZoneIds &) const
 
virtual void startReadingChildCellCountsForCells () const
 
virtual short getChildCellCountForCell (const ElemIdType cellId) const
 
virtual size_t getChildCellCountsForCellsInRange (const ElemIdType, const ElemIdType, short *const, const size_t) const
 
virtual size_t getChildCellCountsForCellsInZone (const ZoneIdType, short *const, const size_t) const
 
virtual void endReadingChildCellCountsForCells () const
 
virtual void startReadingChildCellIdsForCells () const
 
virtual size_t getChildCellIdsForCell (const ElemIdType cellId, ElemIdType *const ccid, const size_t) const
 
virtual size_t getChildCellIdsForCellsInRange (const ElemIdType, const ElemIdType, ElemIdType *const, const size_t) const
 
virtual size_t getChildCellIdsForCellsInZone (const ZoneIdType, ElemIdType *const, const size_t) const
 
virtual void endReadingChildCellIdsForCells () const
 
virtual void endReadingChildCellsForCells () const
 
Special Case Sections
virtual void startReadingCategorizedCaseSections (const ZoneCategory, CategoryNames &categories) const
 
virtual PlainDataType startReadingCaseSectionForCategory (const CategoryName &catgeory, ZoneIds &zoneIds) const
 
virtual void startReadingCaseSectionDataCounts () const
 
virtual bool hasUniformCaseSectionDataCountForZone (const ZoneIdType zoneId, short *const dc) const
 
virtual short getCaseSectionDataCountForElement (const ElemIdType elemId) const
 
virtual size_t getCaseSectionDataCountsForElementsInRange (const ElemIdType minId, const ElemIdType maxId, short *const dc, const size_t) const
 
virtual size_t getCaseSectionDataCountsForElementsInZone (const ZoneIdType zoneId, short *const dc, const size_t) const
 
virtual void endReadingCaseSectionDataCounts () const
 
virtual void startReadingCaseSectionData () const
 
virtual size_t getCaseSectionDataForElement (const ElemIdType elemId, void *const data, const size_t) const
 
virtual size_t getCaseSectionDataForElementsInRange (const ElemIdType minId, const ElemIdType maxId, void *const data, const size_t) const
 
virtual size_t getCaseSectionDataForElementsInZone (const ZoneIdType zoneId, void *const data, const size_t) const
 
virtual void endReadingCaseSectionData () const
 
virtual void endReadingCategorizedCaseSections () const
 
bool isReadingData () const
 DEPRECATED: Function to determine whether it is possible to read data of type ansys::DataClass::CFF_RESULTS. More...
 
Time Levels
void startReadingTimeLevel (const TimeLevelType=CffFinalTimeLevel) const
 
void endReadingTimeLevel () const
 
virtual void startReadingPhase (const PhaseIdType=1) const
 
virtual bool getAttributesOfPhase (PhaseIdType, AttributeNames &) const
 
virtual bool getAttributeValueOfPhase (PhaseIdType, const AttributeName &, AttributeValue &) const
 
virtual bool getAttributesOfPhase (AttributeNames &) const
 
virtual bool getAttributeValueOfPhase (const AttributeName &, AttributeValue &) const
 
virtual bool getAttributesOfPhase (const PhaseName &, AttributeNames &) const
 
virtual bool getAttributeValueOfPhase (const PhaseName &, const AttributeName &, AttributeValue &) const
 
virtual void endReadingPhase () const
 
Variables (Solution Phases)
virtual size_t getPhaseVariableCountOfCategory (const ZoneCategory) const
 
virtual void getPhaseVariablesOfCategory (const ZoneCategory, VariableIds &) const
 
virtual void getPhaseVariablesOfCategory (const ZoneCategory, VariableNames &) const
 
bool getVariableId (PhaseIdType phaseId, const VariableName &varName, VariableIdType &varId) const
 
bool getVariableId (const VariableName &varName, VariableIdType &varId) const
 
bool getVariableId (const PhaseName &phaseName, const VariableName &varName, VariableIdType &varId) const
 
Solution Data
virtual size_t startReadingZonesOfCategoryWithPhaseVariable (const ZoneCategory zoneCategory, const VariableIdType varId, ZoneIds &zoneIds) const
 Determine the zones in which the phase variable exists, and if valid prepare to read the solution data for the variable in those zones. More...
 
virtual size_t startReadingZonesOfCategoryWithPhaseVariable (const ZoneCategory zoneCategory, const VariableName &varName, ZoneIds &zoneIds) const
 Determine the zones in which the phase variable exists, and if valid prepare to read the solution data for the variable in those zones. More...
 
virtual size_t getValuesOfPhaseVariableForElement (const ElemIdType elemId, double *const vals, const size_t) const
 Read solution data for a single element within a zone that contains the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More...
 
virtual size_t getValuesOfPhaseVariableForElementsInRange (const ElemIdType minId, const ElemIdType maxId, double *const vals, const size_t) const
 Read solution data for a range of elements for the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More...
 
virtual size_t getValuesOfPhaseVariableForElementsInZone (const ZoneIdType zoneId, double *const vals, const size_t) const
 Read solution data for a zone variable for all elements within a zone requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More...
 
virtual size_t getValuesOfPhaseVariableForElement (const ElemIdType elemId, float *const vals, const size_t) const
 Read solution data for a single element within a zone that contains the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More...
 
virtual size_t getValuesOfPhaseVariableForElementsInRange (const ElemIdType minId, const ElemIdType maxId, float *const vals, const size_t) const
 Read solution data for a range of elements for the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More...
 
virtual size_t getValuesOfPhaseVariableForElementsInZone (const ZoneIdType zoneId, float *const vals, const size_t) const
 Read solution data for a zone variable for all elements within a zone requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable. More...
 
virtual void endReadingZonesOfCategoryWithPhaseVariable () const
 End reading solution data for a zone variable previously started by a call to startReadingZonesOfCategoryWithPhaseVariable. More...
 
Variables (Particle Phases)
virtual bool hasParticles () const
 
virtual bool hasParticles (const PhaseName &phaseName) const
 
virtual bool hasParticles (const PhaseIdType phaseId) const
 
virtual bool startReadingParticles () const
 
virtual bool startReadingParticles (const PhaseName &phaseName) const
 
virtual bool startReadingParticles (const PhaseIdType phaseId) const
 
Particle Track Availability
virtual bool hasParticleTracks ()
 Check if there are any particle tracks. More...
 
virtual bool hasParticleTracks (const MeshIdType meshId, const TargetCategory target=TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN, const PartitionIdType partition=-1)
 Check whether particular particle tracks exist. More...
 
virtual bool hasParticleTracks (const PhaseIdType phaseId, const MeshIdType meshId, const TargetCategory target=TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN, const PartitionIdType partition=-1)
 Check whether partucular particle tracks exist. More...
 
virtual bool hasParticleTracksInActivePhase ()
 Check if there are particle track data in active phase of active mesh set. More...
 
virtual void getMeshBranchesWithParticleTracks (MeshIds &mids, TargetCategories &tgts, PartitionIds &pids)
 Get all mesh branches that contain particle track data, each mesh branch is specified by a pair of three values: meshId, target and partition (only applicable to the situation that target is PARTITION_POST) More...
 
virtual std::vector< PhaseIdTypegetPhasesWithParticleTracks (const MeshIdType meshId=-1, const TargetCategory target=TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN, const PartitionIdType partition=-1)
 Get all phases that contain particle track data in mesh specified by mesh, target and partition. More...
 
virtual void startReadingParticleTracks (const PhaseIdType phaseId=-1, const MeshIdType meshId=-1, const TargetCategory target=TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN, const PartitionIdType partition=-1)
 Start reading particle tracks by phase in the mesh, target and partition. More...
 
virtual void getVariablesOfParticleTrack (std::vector< VariableName > &varNames, std::vector< bool > &isConst, std::vector< PlainDataType > &datTypes)
 Get all variables in the particle track group. More...
 
virtual void getParticleTrackGroups (std::vector< std::string > &groupNames)
 Get names of all particle track groups in current path. More...
 
virtual size_t startReadingParticleTrackGroup (const std::string &groupName)
 Start reading a specific particle track group. More...
 
virtual void getChunksInParticleTrackGroup (std::vector< size_t > &chunks)
 Get all chunk indices within the active particle track group. More...
 
virtual size_t startReadingChunkInParticleTrackGroup (const size_t chunkIndex=0)
 Start reading the specified chunk within the particle track group. More...
 
virtual size_t startReadingVariableOfParticleTracksInChunk (const VariableName &varName)
 Start reading variable in the current chunk. More...
 
virtual void getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, unsigned char *const data, const size_t dataSize)
 Get data for the variable within the specified particle within the active chunk. More...
 
virtual void getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, char *const data, const size_t dataSize)
 Get data for the variable within the specified particle within the active chunk. More...
 
virtual void getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, short *const data, const size_t dataSize)
 Get data for the variable within the specified particle within the active chunk. More...
 
virtual void getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, unsigned int *const data, const size_t dataSize)
 Get data for the variable within the specified particle within the active chunk. More...
 
virtual void getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, int *const data, const size_t dataSize)
 Get data for the variable within the specified particle within the active chunk. More...
 
virtual void getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, long *const data, const size_t dataSize)
 Get data for the variable within the specified particle within the active chunk. More...
 
virtual void getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, long long *const data, const size_t dataSize)
 Get data for the variable within the specified particle within the active chunk. More...
 
virtual void getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, float *const data, const size_t dataSize)
 Get data for the variable within the specified particle within the active chunk. More...
 
virtual void getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, double *const data, const size_t dataSize)
 Get data for the variable within the specified particle within the active chunk. More...
 
virtual void getVariableDataOfParticleTrackInChunk (const ElemIdType particleId, size_t *const data, const size_t dataSize)
 Get data for the variable within the specified particle within the active chunk. More...
 
virtual void getVariableDataOfAllParticleTracksInChunk (unsigned char *const data, const size_t dataSize)
 Get data for the variable in all particle tracks in the chunk. More...
 
virtual void getVariableDataOfAllParticleTracksInChunk (char *const data, const size_t dataSize)
 Get data for the variable in all particle tracks in the chunk. More...
 
virtual void getVariableDataOfAllParticleTracksInChunk (short *const data, const size_t dataSize)
 Get data for the variable in all particle tracks in the chunk. More...
 
virtual void getVariableDataOfAllParticleTracksInChunk (unsigned int *const data, const size_t dataSize)
 Get data for the variable in all particle tracks in the chunk. More...
 
virtual void getVariableDataOfAllParticleTracksInChunk (int *const data, const size_t dataSize)
 Get data for the variable in all particle tracks in the chunk. More...
 
virtual void getVariableDataOfAllParticleTracksInChunk (long *const data, const size_t dataSize)
 Get data for the variable in all particle tracks in the chunk. More...
 
virtual void getVariableDataOfAllParticleTracksInChunk (long long *const data, const size_t dataSize)
 Get data for the variable in all particle tracks in the chunk. More...
 
virtual void getVariableDataOfAllParticleTracksInChunk (float *const data, const size_t dataSize)
 Get data for the variable in all particle tracks in the chunk. More...
 
virtual void getVariableDataOfAllParticleTracksInChunk (double *const data, const size_t dataSize)
 Get data for the variable in all particle tracks in the chunk. More...
 
virtual void getVariableDataOfAllParticleTracksInChunk (size_t *const data, const size_t dataSize)
 Get data for the variable in all particle tracks in the chunk. More...
 
virtual void endReadingVariableOfParticleTracksInChunk ()
 End reading variables in chunk. More...
 
virtual void endReadingChunkOfParticleTrackGroup ()
 End reading chunk in particle track group. More...
 
virtual void endReadingParticleTrackGroup ()
 End reading particle track group. More...
 
virtual void endReadingParticleTracks ()
 End reading particle tracks. More...
 
- 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 CffLocationModelgetLocationModel () 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 TimeLevelsgetTimeLevels () const
 
TimeLevelType getTimeLevel () const
 
- Public Member Functions inherited from ansys::CffVersion
 CffVersion ()
 
 ~CffVersion ()
 

Protected Member Functions

bool fileExists (const std::string &) const
 
- Protected Member Functions inherited from ansys::CffBase
CffReadable isSupported (const std::string &version) const
 Check whether the version can be read by this version of the CFF SDK. More...
 
void setMeshSize (const ElemIdType nDims, const ElemIdType nodesCount, const ElemIdType edgesCount, const ElemIdType facesCount, const ElemIdType cellsCount)
 Set the mesh size info This function is for providing top level meta data: the total mesh size of all zones In case you do not save certain entity, for example, edges, then the input edgesCount should be 0. More...
 
virtual void setZoneAdjacency ()
 
void setFaceCellZone0Ids (const std::map< ZoneIdType, std::list< ZoneIdType > > &)
 Set the c0 cell zones of all face zones The CellZone0 (c0) cell zones are the cell zones adjacent to the face zone and at the side of face normal direction The information provided here will be helpful for quicker establishment of zone level topology when reading the mesh Mesh without those information can still be read, but would be much slower. More...
 
void setFaceCellZone1Ids (const std::map< ZoneIdType, std::list< ZoneIdType > > &)
 Set the c1 cell zones of all face zones The CellZone1 (c1) cell zones are the cell zones adjacent to the face zone and at the side opposite to face normal direction The information provided here will be helpful for quicker establishment of zone level topology when reading the mesh Mesh without those information can still be read, but would be much slower. More...
 
void getFaceCellZone0Ids (std::map< ZoneIdType, std::list< ZoneIdType > > &)
 
void getFaceCellZone1Ids (std::map< ZoneIdType, std::list< ZoneIdType > > &)
 
void setCellFaceZoneIds (const std::map< ZoneIdType, std::list< ZoneIdType > > &)
 Set the face zones ids of all cell zones The face zones of a cell zone are all face zones that adjacent to the cell zone The information provided here will be helpful for quicker establishment of zone level topology when reading the mesh Mesh without those information can still be read, but would be much slower. More...
 
void getSortedMinIdZoneId (const ZoneCategory, std::vector< std::pair< ElemIdType, ZoneIdType > > &minIdZoneId) const
 
std::string getGroupNameForPhase (PhaseIdType phaseId) const
 
CffSolutionModel * solutionModel () const
 
virtual void initLocationModel () const
 
CffLocationModellocationModel () 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
 

Start/End Reading

Start reading data of a specific source of data

Parameters
[in]dataClass- The data source to begin reading CFF_CASE or CFF_RESULTS
See also
endReading setReadAllSettings setKeyWordsForSettingsToBeRead setSkipReadZoneTopology setHeavyDataCacheMode setMesh setTarget setPartition setVariableTarget setVariableRecipeProvider
virtual bool isReading (DataClass dataClass) const
 Return whether a reading of the class of data specified is possible. More...
 
virtual bool startReading (DataClass dataClass)
 
virtual bool endReading (DataClass dataClass)
 Finish reading data of a specific source of data. More...
 
void setReading (DataClass, bool)
 Set whether a reading of the class of data specified is possible. More...
 

Variable Attributes (Solution Phases)

virtual bool getAttributesOfPhaseVariable (VariableIdType, AttributeNames &) const
 
virtual bool getAttributeValueOfPhaseVariable (VariableIdType, const AttributeName &, AttributeValue &) const
 
virtual bool getAttributesOfPhaseVariable (const VariableName &, AttributeNames &) const
 
virtual bool getAttributeValueOfPhaseVariable (const VariableName &, const AttributeName &, AttributeValue &) const
 
virtual bool getAttributesOfPhaseVariable (PhaseIdType phaseId, const VariableName &, AttributeNames &) const
 
virtual bool getAttributeValueOfPhaseVariable (PhaseIdType, const VariableName &, const AttributeName &, AttributeValue &) const
 
virtual bool getAttributesOfPhaseVariable (const PhaseName &phaseName, const VariableName &, AttributeNames &) const
 
virtual bool getAttributeValueOfPhaseVariable (const PhaseName &, const VariableName &, const AttributeName &, AttributeValue &) const
 
void applyVariableRecipe (VariableIdType varId, AttributeName name, AttributeValue &value) const
 
virtual void getInjectionNames (InjectionNames &) const
 
virtual void getVariablesOfInjection (const InjectionName &name, VariableNames &varNames) const
 
virtual void getVariablesOfInjection (const InjectionName &name, VariableIds &varIds) const
 
virtual size_t getNumOfParticlesInInjection (const InjectionName &name) const
 
virtual size_t startReadingVariableForParticlesInInjection (const InjectionName &injName, const VariableName &varName, PlainDataType &dataType) const
 
virtual size_t getValuesOfVariableForParticlesInInjection (double *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfVariableForParticlesInInjection (float *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfVariableForParticlesInInjection (ElemIdType *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfVariableForParticlesInInjection (int *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfVariableForParticlesInInjection (short *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfVariableForParticlesInInjection (unsigned int *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfVariableForParticlesInInjection (long *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfVariableForParticlesInInjection (long long *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfVariableForParticlesInInjection (char *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfVariableForParticlesInInjection (unsigned char *const vals, size_t const dataSize) const
 
virtual void endReadingVariableForParticlesInInjection () const
 
virtual void endReadingParticles () const
 

Data Sets

virtual bool getSetNames (std::vector< std::string > &setNames) const
 
virtual bool getSetNames (const DataClass dataClass, std::vector< std::string > &setNames) const
 
virtual bool getSetNames (const DataClass dataClass, const ZoneCategory cat, std::vector< std::string > &setNames) const
 
virtual bool startReadingSet (const DataClass dataClass, const ZoneCategory cat, const std::string &setName)
 
virtual void startReadingIdsForSet (std::vector< size_t > &nElems, std::vector< ElemIdType > &minId, std::vector< ElemIdType > &maxId)
 
virtual size_t getIdsForSetInRange (const ElemIdType minId, const ElemIdType maxId, ElemIdType *const setId, const size_t dataSize)
 
virtual void endReadingIdsForSet () const
 
virtual void getVariablesInSet (VariableNames &varNames, std::vector< bool > &hasSize) const
 
virtual void startReadingVariableLengthedVarForSet (const VariableName &varName, PlainDataType &dataType)
 
virtual PlainDataType startReadingSizeOfVariableLengthedVarForSet () const
 
virtual size_t getSizeOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, CountType *const counts, size_t const dataSize) const
 
virtual size_t getSizeOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, int *const counts, size_t const dataSize) const
 
virtual size_t getSizeOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, size_t *const counts, size_t const dataSize) const
 
virtual void endReadingSizeOfVariableLengthedVarForSet () const
 
virtual void startReadingDataOfVariableLengthedVarForSet () const
 
virtual size_t getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, unsigned char *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const
 
virtual size_t getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, char *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const
 
virtual size_t getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, short *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const
 
virtual size_t getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, unsigned int *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const
 
virtual size_t getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, int *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const
 
virtual size_t getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, long *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const
 
virtual size_t getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, long long *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const
 
virtual size_t getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, float *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const
 
virtual size_t getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, double *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const
 
virtual size_t getValuesOfVariableLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, size_t *const vals, size_t const dataSize=std::numeric_limits< size_t >::max()) const
 
virtual void endReadingDataOfVariableLengthedVarForSet () const
 
virtual void endReadingVariableLengthedVarForSet () const
 
virtual size_t startReadingConstantLengthedVarForSet (const VariableName &varName, PlainDataType &dataType) const
 
virtual size_t getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, unsigned char *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, char *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, short *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, unsigned int *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, int *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, long *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, long long *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, float *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, double *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfConstantLengthedVarForSetInRange (const ElemIdType minId, const ElemIdType maxId, size_t *const vals, size_t const dataSize) const
 
virtual void endReadingConstantLengthedVarForSet () const
 
virtual void getOtherVariablesInSet (VariableNames &varNames) const
 
virtual size_t startReadingOtherVariableForSet (const VariableName &varName, PlainDataType &dataType, size_t &numElems) const
 
virtual size_t getValuesOfOtherVariableForSet (unsigned char *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfOtherVariableForSet (char *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfOtherVariableForSet (short *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfOtherVariableForSet (unsigned int *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfOtherVariableForSet (int *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfOtherVariableForSet (long *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfOtherVariableForSet (long long *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfOtherVariableForSet (float *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfOtherVariableForSet (double *const vals, size_t const dataSize) const
 
virtual size_t getValuesOfOtherVariableForSet (size_t *const vals, size_t const dataSize) const
 
virtual void endReadingOtherVariableForSet () const
 
virtual void endReadingSet ()
 
virtual bool startReadingSetData (const DataClass dataClass, const ZoneCategory cat, const std::string &setName)
 
virtual size_t startReadingIdsForSetData ()
 
virtual size_t getNumRowsOfSetData (const int nth) const
 
virtual bool getIdsForSetData (const int nth, ElemIdType *const setId, const size_t dataSize) const
 
virtual void endReadingIdsForSetData () const
 
virtual void getVariablesInSetData (VariableNames &varNames, std::vector< bool > &hasSize) const
 
virtual void startReadingVariableLengthVarForSetData (const VariableName &varName)
 
virtual PlainDataType getDataTypeOfDataForSetData () const
 
virtual PlainDataType getDataTypeOfSizeForSetData () const
 
virtual size_t startReadingSizeOfVariableLengthVarForSetData () const
 
virtual bool getSizeOfVariableLengthVarForSetData (const int nth, void *const counts, size_t const dataSize) const
 
virtual void endReadingSizeOfVariableLengthVarForSetData () const
 
virtual size_t startReadingDataOfVariableLengthVarForSetData () const
 
virtual bool getDataOfVariableLengthVarForSetData (const int nth, void *const vals, size_t const dataSize) const
 
virtual void endReadingDataOfVariableLengthVarForSetData () const
 
virtual void endReadingVariableLengthVarForSetData () const
 
virtual size_t startReadingConstantLengthVarForSetData (const VariableName &varName) const
 
virtual size_t getColumnsNumOfConstantLengthVarForSetData (const size_t nth) const
 
virtual bool getDataOfConstantLengthVarForSetData (const int nth, void *const vals, size_t const dataSize) const
 
virtual void endReadingConstantLengthVarForSetData () const
 
virtual void getOtherVariablesInSetData (VariableNames &varNames) const
 
virtual size_t startReadingOtherDataForSetData (const VariableName &varName, PlainDataType &dataType, size_t &numElems) const
 
virtual bool getOtherDataForSetData (void *const vals, size_t const dataSize) const
 
virtual void endReadingOtherDataForSetData () const
 
virtual void endReadingSetData ()
 

Additional Inherited Members

- Static Public Member Functions inherited from ansys::CffVersion
static unsigned int getMajor ()
 
static unsigned int getMinor ()
 
static unsigned int getPatch ()
 
static std::string getSHA ()
 
static bool isBeta ()
 
static std::string apiVersionAsString (const std::string &separator=".")
 
static std::string ansysApplicationVersion (const std::string &appName)
 
static std::string copyright (bool allRightsReserved)
 
- Static Public Attributes inherited from ansys::CffBase
static std::string _defaultSettingsPath = "settings"
 
- Protected Types inherited from ansys::CffBase
enum class  UpdateMethod { CaseOnly = 1 , ResultsOnly , CaseAndResults }
 
- Protected Attributes inherited from ansys::CffBase
std::unique_ptr< DataInterface > _data
 
std::unique_ptr< const CffVariableAttributeProvider > _varAttrProvider
 

Detailed Description

Class that provides functions to access data stored within a CFF 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 will be returned according to the rules defined in the CFF DataModels.

// Access data through provider
delete provider;
Class that provides functions to access data stored within a CFF database. The database may be stored...
Definition: CffProvider.hpp:21
CffProvider()
Constructor.
Definition: CffProviderMethods.cpp:53
virtual bool endReading(DataClass dataClass)
Finish reading data of a specific source of data.
Definition: CffProviderMethods.cpp:185
virtual bool startReading(DataClass dataClass)
Definition: CffProviderMethods.cpp:135
@ CFF_CASE
Definition: CffTypes.h:419

Typically however CFF data is stored in files. Files are accessed using derived subclasses using the additional functions provided in ansys::CffFileProvider. See ansys::CffFileProvider for details of however to create a provider for a particular file.

Constructor & Destructor Documentation

◆ CffProvider()

ansys::CffProvider::CffProvider ( )

Constructor.

◆ ~CffProvider()

ansys::CffProvider::~CffProvider ( )
virtual

Destructor.

Member Function Documentation

◆ applyVariableRecipe()

void ansys::CffProvider::applyVariableRecipe ( VariableIdType  varId,
AttributeName  name,
AttributeValue value 
) const
protected

◆ availableMeshIds()

MeshIds ansys::CffProvider::availableMeshIds ( DataClass  dataClass = DataClass::CFF_CASE) const
virtual

Obtain the complete list of mesh Identifiers available.

Parameters
[in]dataClass- Data source in which to find the mesh identifiers.
Returns
- The available mesh identifiers.
See also
hasMeshId

◆ availablePartitionIds() [1/2]

PartitionIds ansys::CffProvider::availablePartitionIds ( ) const

Obtain the complete list of partitions available.

See also
hasPartition getPartitionCount

◆ availablePartitionIds() [2/2]

PartitionIds ansys::CffProvider::availablePartitionIds ( MeshIdType  meshId,
DataClass  dataClass = DataClass::CFF_CASE 
) const
virtual

Obtain the complete list of partitions available for a specific mesh identifier.

Parameters
[in]meshId- The mesh identifier for which to obtain the partitions.
[in]dataClass- The data source from which to query the partitions.
Returns
- The available partition ids.
See also
hasPartition getPartitionCount

◆ availableTargets() [1/2]

TargetCategories ansys::CffProvider::availableTargets ( ) const

Obtain the complete list of targets available.

Returns
- The available targets.
See also
hasTarget

◆ availableTargets() [2/2]

TargetCategories ansys::CffProvider::availableTargets ( MeshIdType  meshId,
DataClass  dataClass = DataClass::CFF_CASE 
) const
virtual

Obtain the complete list of targets available for a specific mesh identifier.

Parameters
[in]meshId- The mesh identifier for which to obtain the targets.
[in]dataClass- The data source from which to query the targets.
Returns
- The available targets.
See also
hasTarget

◆ dump()

void ansys::CffProvider::dump ( std::string  fileName = "settings.xml") const
virtual

Dump all setting key/value pairs to a file.

This debugging function allows the settings model contents to be written to a file.

Parameters
[in]fileName- The file to open and write the settings data to.

◆ endReading()

bool ansys::CffProvider::endReading ( DataClass  dataClass)
virtual

Finish reading data of a specific source of data.

Parameters
[in]dataClass- The data source to begin reading CFF_CASE or CFF_RESULTS
See also
startReading

Reimplemented in ansys::CffFileProvider.

◆ endReadingCaseSectionData()

void ansys::CffProvider::endReadingCaseSectionData ( ) const
virtual

◆ endReadingCaseSectionDataCounts()

void ansys::CffProvider::endReadingCaseSectionDataCounts ( ) const
virtual

◆ endReadingCategorizedCaseSections()

void ansys::CffProvider::endReadingCategorizedCaseSections ( ) const
virtual

◆ endReadingCell0sForFaces()

void ansys::CffProvider::endReadingCell0sForFaces ( ) const
virtual

Finish reading the cell 0 parents.

This function must always be called after calling getCell0ForFace(), getCell0sForFacesInRange(), getCell0sForFacesInZone()

See also
startReadingCell0sForFaces, getCell0ForFace, getCell0sForFacesInRange, getCell0sForFacesInZone

◆ endReadingCell1sForFaces()

void ansys::CffProvider::endReadingCell1sForFaces ( ) const
virtual

Finish reading the cell 1 parents.

This function must always be called after calling getCell0ForFace(), getCel1sForFacesInRange(), getCell1sForFacesInZone()

See also
startReadingCell1sForFaces, getCell1ForFace, getCell1sForFacesInRange, getCell1sForFacesInZone

◆ endReadingChildCellCountsForCells()

void ansys::CffProvider::endReadingChildCellCountsForCells ( ) const
virtual

◆ endReadingChildCellIdsForCells()

void ansys::CffProvider::endReadingChildCellIdsForCells ( ) const
virtual

◆ endReadingChildCellsForCells()

void ansys::CffProvider::endReadingChildCellsForCells ( ) const
virtual

◆ endReadingChildFaceCountsForFaces()

void ansys::CffProvider::endReadingChildFaceCountsForFaces ( ) const
virtual

◆ endReadingChildFaceIdsForFaces()

void ansys::CffProvider::endReadingChildFaceIdsForFaces ( ) const
virtual

◆ endReadingChildFacesForFaces()

void ansys::CffProvider::endReadingChildFacesForFaces ( ) const
virtual

◆ endReadingChunkOfParticleTrackGroup()

void ansys::CffProvider::endReadingChunkOfParticleTrackGroup ( )
virtual

End reading chunk in particle track group.

◆ endReadingConstantLengthedVarForSet()

void ansys::CffProvider::endReadingConstantLengthedVarForSet ( ) const
virtual

◆ endReadingConstantLengthVarForSetData()

void ansys::CffProvider::endReadingConstantLengthVarForSetData ( ) const
virtual

◆ endReadingCoordinatesForNodes()

void ansys::CffProvider::endReadingCoordinatesForNodes ( ) const
virtual

Finish reading coordinates for nodes.

◆ endReadingDataOfVariableLengthedVarForSet()

void ansys::CffProvider::endReadingDataOfVariableLengthedVarForSet ( ) const
virtual

◆ endReadingDataOfVariableLengthVarForSetData()

void ansys::CffProvider::endReadingDataOfVariableLengthVarForSetData ( ) const
virtual

◆ endReadingFaceCountsForCells()

void ansys::CffProvider::endReadingFaceCountsForCells ( ) const
virtual

◆ endReadingFaceIdsForCells()

void ansys::CffProvider::endReadingFaceIdsForCells ( ) const
virtual

◆ endReadingFacesForCells()

void ansys::CffProvider::endReadingFacesForCells ( ) const
virtual

◆ endReadingIdsForSet()

void ansys::CffProvider::endReadingIdsForSet ( ) const
virtual

◆ endReadingIdsForSetData()

void ansys::CffProvider::endReadingIdsForSetData ( ) const
virtual

◆ endReadingInterfaceDataForFaces()

void ansys::CffProvider::endReadingInterfaceDataForFaces ( ) const
virtual

◆ endReadingNodeCountsForCells()

void ansys::CffProvider::endReadingNodeCountsForCells ( ) const
virtual

◆ endReadingNodeCountsForEdges()

void ansys::CffProvider::endReadingNodeCountsForEdges ( ) const
virtual

◆ endReadingNodeCountsForFaces()

◆ endReadingNodeIdsForCells()

void ansys::CffProvider::endReadingNodeIdsForCells ( ) const
virtual

◆ endReadingNodeIdsForEdges()

void ansys::CffProvider::endReadingNodeIdsForEdges ( ) const
virtual

◆ endReadingNodeIdsForFaces()

◆ endReadingNodesForCells()

void ansys::CffProvider::endReadingNodesForCells ( ) const
virtual

◆ endReadingNodesForEdges()

void ansys::CffProvider::endReadingNodesForEdges ( ) const
virtual

◆ endReadingNodesForFaces()

◆ endReadingOtherDataForSetData()

void ansys::CffProvider::endReadingOtherDataForSetData ( ) const
virtual

◆ endReadingOtherVariableForSet()

void ansys::CffProvider::endReadingOtherVariableForSet ( ) const
virtual

◆ endReadingParticles()

void ansys::CffProvider::endReadingParticles ( ) const
virtual

◆ endReadingParticleTrackGroup()

void ansys::CffProvider::endReadingParticleTrackGroup ( )
virtual

End reading particle track group.

◆ endReadingParticleTracks()

void ansys::CffProvider::endReadingParticleTracks ( )
virtual

End reading particle tracks.

◆ endReadingPartitionIdsForCells()

void ansys::CffProvider::endReadingPartitionIdsForCells ( ) const
virtual

◆ endReadingPhase()

void ansys::CffProvider::endReadingPhase ( ) const
virtual

◆ endReadingSet()

void ansys::CffProvider::endReadingSet ( )
virtual

◆ endReadingSetData()

void ansys::CffProvider::endReadingSetData ( )
virtual

◆ endReadingShadowFaceIdsForFaces()

void ansys::CffProvider::endReadingShadowFaceIdsForFaces ( ) const
virtual

◆ endReadingSizeOfVariableLengthedVarForSet()

void ansys::CffProvider::endReadingSizeOfVariableLengthedVarForSet ( ) const
virtual

◆ endReadingSizeOfVariableLengthVarForSetData()

void ansys::CffProvider::endReadingSizeOfVariableLengthVarForSetData ( ) const
virtual

◆ endReadingTimeLevel()

void ansys::CffProvider::endReadingTimeLevel ( ) const

◆ endReadingTypesForCells()

void ansys::CffProvider::endReadingTypesForCells ( ) const
virtual

Finish reading the types of cells.

See also
startReadingTypesForCells, hasUnoformTypeForCellsInZone, getTypeForCell, getTypesForCellsInRange, getTypesForCellsInZone,

◆ endReadingVariableForParticlesInInjection()

void ansys::CffProvider::endReadingVariableForParticlesInInjection ( ) const
virtual

◆ endReadingVariableLengthedVarForSet()

void ansys::CffProvider::endReadingVariableLengthedVarForSet ( ) const
virtual

◆ endReadingVariableLengthVarForSetData()

void ansys::CffProvider::endReadingVariableLengthVarForSetData ( ) const
virtual

◆ endReadingVariableOfParticleTracksInChunk()

void ansys::CffProvider::endReadingVariableOfParticleTracksInChunk ( )
virtual

End reading variables in chunk.

◆ endReadingZonesOfCategoryWithPhaseVariable()

void ansys::CffProvider::endReadingZonesOfCategoryWithPhaseVariable ( ) const
virtual

End reading solution data for a zone variable previously started by a call to startReadingZonesOfCategoryWithPhaseVariable.

See also
startReadingZonesOfCategoryWithPhaseVariable, getValuesOfPhaseVariableForElement, getValuesOfPhaseVariableForElementsInRange, getValuesOfPhaseVariableForElementsInZone

◆ fileExists()

bool ansys::CffProvider::fileExists ( const std::string &  fileName) const
protected

◆ getAttributesOfPhase() [1/3]

bool ansys::CffProvider::getAttributesOfPhase ( AttributeNames names) const
virtual

◆ getAttributesOfPhase() [2/3]

bool ansys::CffProvider::getAttributesOfPhase ( const PhaseName phaseName,
AttributeNames names 
) const
virtual

◆ getAttributesOfPhase() [3/3]

bool ansys::CffProvider::getAttributesOfPhase ( PhaseIdType  phaseId,
AttributeNames names 
) const
virtual

◆ getAttributesOfPhaseVariable() [1/4]

bool ansys::CffProvider::getAttributesOfPhaseVariable ( const PhaseName phaseName,
const VariableName varName,
AttributeNames names 
) const
virtual

Get attributes of phase variable in the supplied phase

Parameters
[in]phaseName- Phase in which variable should exist
[in]varName- Variable name for which to get attributes
[in]names- Attribute names associated with the variable
Returns
- true if successful, false otherwise

◆ getAttributesOfPhaseVariable() [2/4]

bool ansys::CffProvider::getAttributesOfPhaseVariable ( const VariableName varName,
AttributeNames names 
) const
virtual

Get attributes of phase variable in the current phase

Parameters
[in]varName- Variable name for which to get attributes
[in]names- Attribute names associated with the variable
Returns
- true if successful, false otherwise

◆ getAttributesOfPhaseVariable() [3/4]

bool ansys::CffProvider::getAttributesOfPhaseVariable ( PhaseIdType  phaseId,
const VariableName varName,
AttributeNames names 
) const
virtual

Get attributes of phase variable in the supplied phase

Parameters
[in]phaseId- Phase in which variable should exist
[in]varName- Variable name for which to get attributes
[in]names- Attributes associated with the variable
Returns
- true if successful, false otherwise

◆ getAttributesOfPhaseVariable() [4/4]

bool ansys::CffProvider::getAttributesOfPhaseVariable ( VariableIdType  varId,
AttributeNames names 
) const
virtual

Get attributes of phase variable

Parameters
[in]varId- Variable Id for which to get attributes
[in]names- Attributes associated with the variable @[out] return - true if successful, false otherwise

◆ getAttributeValueOfPhase() [1/3]

bool ansys::CffProvider::getAttributeValueOfPhase ( const AttributeName name,
AttributeValue value 
) const
virtual

◆ getAttributeValueOfPhase() [2/3]

bool ansys::CffProvider::getAttributeValueOfPhase ( const PhaseName phaseName,
const AttributeName name,
AttributeValue value 
) const
virtual

◆ getAttributeValueOfPhase() [3/3]

bool ansys::CffProvider::getAttributeValueOfPhase ( PhaseIdType  phaseId,
const AttributeName name,
AttributeValue value 
) const
virtual

◆ getAttributeValueOfPhaseVariable() [1/4]

bool ansys::CffProvider::getAttributeValueOfPhaseVariable ( const PhaseName phaseName,
const VariableName varName,
const AttributeName name,
AttributeValue value 
) const
virtual

Get attribute value of phase variable in the supplied phase

Parameters
[in]phaseName- Phase in which variable should exist
[in]varName- Variable to get attributes for
[in]name- Name of attribute for which to return value
[out]value- Value of the attribute if successful
Returns
- true if successful, false otherwise

◆ getAttributeValueOfPhaseVariable() [2/4]

bool ansys::CffProvider::getAttributeValueOfPhaseVariable ( const VariableName varName,
const AttributeName name,
AttributeValue value 
) const
virtual

Get attribute value of phase variable in the current phase

Parameters
[in]varName- Variable name for which to get value
[in]name- Name of attribute for which to return value
[out]value- Value of the attribute if successful
Returns
- true if successful, false otherwise

◆ getAttributeValueOfPhaseVariable() [3/4]

bool ansys::CffProvider::getAttributeValueOfPhaseVariable ( PhaseIdType  phaseId,
const VariableName varName,
const AttributeName name,
AttributeValue value 
) const
virtual

Get attribute value of phase variable in the supplied phase

Parameters
[in]phaseId- Phase in which variable should exist
[in]varName- Variable to get attributes for
[in]name- Name of attribute for which to return value
[out]value- Value of the attribute if successful
Returns
- true if successful, false otherwise

◆ getAttributeValueOfPhaseVariable() [4/4]

bool ansys::CffProvider::getAttributeValueOfPhaseVariable ( VariableIdType  varId,
const AttributeName name,
AttributeValue value 
) const
virtual

Get attribute value of phase variable

Parameters
[in]varId- Variable Id for which to get attributes
[in]name- Name of attribute for which to return value
[out]value- Value of the attribute if successful
Returns
- true if successful, false otherwise

◆ getCaseSectionDataCountForElement()

short ansys::CffProvider::getCaseSectionDataCountForElement ( const ElemIdType  elemId) const
virtual

◆ getCaseSectionDataCountsForElementsInRange()

size_t ansys::CffProvider::getCaseSectionDataCountsForElementsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
short *const  dc,
const size_t  dataSize 
) const
virtual

◆ getCaseSectionDataCountsForElementsInZone()

size_t ansys::CffProvider::getCaseSectionDataCountsForElementsInZone ( const ZoneIdType  zoneId,
short *const  dc,
const size_t  dataSize 
) const
virtual

◆ getCaseSectionDataForElement()

size_t ansys::CffProvider::getCaseSectionDataForElement ( const ElemIdType  elemId,
void *const  data,
const size_t  dataSize 
) const
virtual

◆ getCaseSectionDataForElementsInRange()

size_t ansys::CffProvider::getCaseSectionDataForElementsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
void *const  data,
const size_t  dataSize 
) const
virtual

◆ getCaseSectionDataForElementsInZone()

size_t ansys::CffProvider::getCaseSectionDataForElementsInZone ( const ZoneIdType  zoneId,
void *const  data,
const size_t  dataSize 
) const
virtual

◆ getCell0ForFace()

ElemIdType ansys::CffProvider::getCell0ForFace ( const ElemIdType  faceId) const
virtual

Obtain cell 0 parent for specified face.

Parameters
[in]faceId- The face for which to obtain parent cell 0.
Returns
- The identifier of parent cell 0, or 0.
See also
startReadingCell0sForFaces, getCell0sForFacesInRange, getCell0sForFacesInZone, endReadingCell0sForFaces

◆ getCell0sForFacesInRange()

size_t ansys::CffProvider::getCell0sForFacesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
ElemIdType *const  fc0,
const size_t  dataSize 
) const
virtual

Obtain cell 0 parents for all faces within a face range.

Parameters
[in]minId- The first face to obtain parent cells for.
[in]maxId- The last face to obtain parent cells for.
[in,out]fc0- The preallocated array of type ElemIdType, in which to hold the cell 0 parents.
[in]dataSize- The allocated size of the array fc0.
Returns
- The number of cell parents read or 0.
See also
startReadingCell0sForFaces, getCell0ForFace, getCell0sForFacesInZone, endReadingCell0sForFaces

◆ getCell0sForFacesInZone()

size_t ansys::CffProvider::getCell0sForFacesInZone ( const ZoneIdType  zoneId,
ElemIdType *const  fc0,
const size_t  dataSize 
) const
virtual

Obtain cell 0 parents for all faces in zone.

Parameters
[in]zoneId- The zone Id for which to read cell 0 parents.
[in,out]fc0- The preallocated array of type ElemIdType, in which to hold the cell 0 parents.
[in]dataSize- The allocated size of the array fc0.
Returns
- The number of cell parents read or 0.
See also
startReadingCell0sForFaces, getCell0ForFace, getCell0sForFacesInRange, endReadingCell0sForFaces,

◆ getCell1ForFace()

ElemIdType ansys::CffProvider::getCell1ForFace ( const ElemIdType  faceId) const
virtual

Obtain cell 1 parent for specified face.

Parameters
[in]faceId- The face for which to obtain parent cell 1.
Returns
- The identifier of parent cell 1, or 0.
See also
startReadingCell1sForFaces, getCell1sForFacesInRange, getCell1sForFacesInZone, endReadingCell1sForFaces

◆ getCell1sForFacesInRange()

size_t ansys::CffProvider::getCell1sForFacesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
ElemIdType *const  fc1,
const size_t  dataSize 
) const
virtual

Obtain cell 1 parents for all faces within a range.

Parameters
[in]minId- The first face to obtain parent cells for.
[in]maxId- The last face to obtain parent cells for.
[in,out]fc1- The preallocated array of type ElemIdType, in which to hold the cell 1 parents.
[in]dataSize- The allocated size of the array fc1.
Returns
- The number of cell parents read or 0.
See also
startReadingCell1sForFaces, getCell1ForFace, getCell1sForFacesInZone, endReadingCell1sForFaces

◆ getCell1sForFacesInZone()

size_t ansys::CffProvider::getCell1sForFacesInZone ( const ZoneIdType  zoneId,
ElemIdType *const  fc1,
const size_t  dataSize 
) const
virtual

Obtain cell 1 parents for all faces in zone.

Parameters
[in]zoneId- The zone Id for which to read cell 1 parents.
[in,out]fc1- The preallocated array of type ElemIdType, in which to hold the cell 1 parents.
[in]dataSize- The allocated size of the array fc1.
Returns
- The number of cell parents read or 0.
See also
startReadingCell1sForFaces, getCell1ForFace, getCell1sForFacesInRange, endReadingCell1sForFaces,

◆ getChildCellCountForCell()

short ansys::CffProvider::getChildCellCountForCell ( const ElemIdType  cellId) const
virtual

◆ getChildCellCountsForCellsInRange()

size_t ansys::CffProvider::getChildCellCountsForCellsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
short * const  ccc,
const size_t  dataSize 
) const
virtual

◆ getChildCellCountsForCellsInZone()

size_t ansys::CffProvider::getChildCellCountsForCellsInZone ( const ZoneIdType  zoneId,
short * const  ccc,
const size_t  dataSize 
) const
virtual

◆ getChildCellIdsForCell()

size_t ansys::CffProvider::getChildCellIdsForCell ( const ElemIdType  cellId,
ElemIdType *const  ccid,
const size_t  dataSize 
) const
virtual

◆ getChildCellIdsForCellsInRange()

size_t ansys::CffProvider::getChildCellIdsForCellsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
ElemIdType * const  ccid,
const size_t  dataSize 
) const
virtual

◆ getChildCellIdsForCellsInZone()

size_t ansys::CffProvider::getChildCellIdsForCellsInZone ( const ZoneIdType  zoneId,
ElemIdType * const  ccid,
const size_t  dataSize 
) const
virtual

◆ getChildFaceCountForFace()

short ansys::CffProvider::getChildFaceCountForFace ( const ElemIdType  faceId) const
virtual

◆ getChildFaceCountsForFacesInRange()

size_t ansys::CffProvider::getChildFaceCountsForFacesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
short * const  fcc,
const size_t  dataSize 
) const
virtual

◆ getChildFaceCountsForFacesInZone()

size_t ansys::CffProvider::getChildFaceCountsForFacesInZone ( const ZoneIdType  zoneId,
short * const  fcc,
const size_t  dataSize 
) const
virtual

◆ getChildFaceIdsForFace()

size_t ansys::CffProvider::getChildFaceIdsForFace ( const ElemIdType  faceId,
ElemIdType *const  fcid,
const size_t  dataSize 
) const
virtual

◆ getChildFaceIdsForFacesInRange()

size_t ansys::CffProvider::getChildFaceIdsForFacesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
ElemIdType * const  fcid,
const size_t  dataSize 
) const
virtual

◆ getChildFaceIdsForFacesInZone()

size_t ansys::CffProvider::getChildFaceIdsForFacesInZone ( const ZoneIdType  zoneId,
ElemIdType * const  fcid,
const size_t  dataSize 
) const
virtual

◆ getChunksInParticleTrackGroup()

void ansys::CffProvider::getChunksInParticleTrackGroup ( std::vector< size_t > &  chunks)
virtual

Get all chunk indices within the active particle track group.

Parameters
[out]chunks- The chunk indices

◆ getColumnsNumOfConstantLengthVarForSetData()

size_t ansys::CffProvider::getColumnsNumOfConstantLengthVarForSetData ( const size_t  nth) const
virtual

◆ getCoordinatesForNode() [1/2]

size_t ansys::CffProvider::getCoordinatesForNode ( const ElemIdType  nodeId,
double *const  coord,
const size_t  dataSize 
) const
virtual

Obtain the coordinates for a specific node.

Parameters
[in]nodeId- The global node identifier to request data for.
[in,out]coord- The preallocated data array of type double in which to store the coordinates.
[in]dataSize- The allocated size of the coord
Returns
- The actual size of the data read.

This function must always be called after calling reading the actual coordinates

See also
startReadingCoordinatesForNodes, getCoordinatesForNodesInRange, getCoordinatesForNodesInZone, endReadingCoordinatesForNodes

◆ getCoordinatesForNode() [2/2]

size_t ansys::CffProvider::getCoordinatesForNode ( const ElemIdType  nodeId,
float *const  coord,
const size_t  dataSize 
) const
virtual

Obtain the coordinates for a specific node.

Parameters
[in]nodeId- The global node identifier to request data for.
[in,out]coord- The preallocated data array of type float in which to store the coordinates.
[in]dataSize- The allocated size of the coord
Returns
- The actual size of the data read.

This function must always be called after calling reading the actual coordinates

See also
startReadingCoordinatesForNodes, getCoordinatesForNodesInRange, getCoordinatesForNodesInZone, endReadingCoordinatesForNodes

◆ getCoordinatesForNodesInRange() [1/2]

size_t ansys::CffProvider::getCoordinatesForNodesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
double *const  coords,
const size_t  dataSize 
) const
virtual

Obtain the coordinates for a node range.

Parameters
[in]minId- The first global node identifier to request.
[in]maxId- The last global node identifier to request.
[in,out]coords- The preallocated data array of type double in which to store the coordinates.
[in]dataSize- The allocated size of the coords
Returns
- The actual size of the data read.
See also
startReadingCoordinatesForNodes, getCoordinatesForNode, getCoordinatesForNodesInZone, endReadingCoordinatesForNodes

◆ getCoordinatesForNodesInRange() [2/2]

size_t ansys::CffProvider::getCoordinatesForNodesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
float *const  coords,
const size_t  dataSize 
) const
virtual

Obtain the coordinates for a node range.

Parameters
[in]minId- The first global node identifier to request.
[in]maxId- The last global node identifier to request.
[in,out]coords- The preallocated data array of type float in which to store the coordinates.
[in]dataSize- The allocated size of the coords
Returns
- The actual size of the data read.
See also
startReadingCoordinatesForNodes, getCoordinatesForNode, getCoordinatesForNodesInZone, endReadingCoordinatesForNodes

◆ getCoordinatesForNodesInZone() [1/2]

size_t ansys::CffProvider::getCoordinatesForNodesInZone ( const ZoneIdType  zoneId,
double *const  coords,
const size_t  dataSize 
) const
virtual

Obtain the coordinates for all nodes within a zone.

Parameters
[in]zoneId- The global zone identifier for which to request coordinates.
[in,out]coords- The preallocated data array of type double in which to store the coordinates.
[in]dataSize- The allocated size of the coords
Returns
- The actual size of the data read.
See also
startReadingCoordinatesForNodes, getCoordinatesForNode, getCoordinatesForNodesInRange, endReadingCoordinatesForNodes

◆ getCoordinatesForNodesInZone() [2/2]

size_t ansys::CffProvider::getCoordinatesForNodesInZone ( const ZoneIdType  zoneId,
float *const  coords,
const size_t  dataSize 
) const
virtual

Obtain the coordinates for all nodes within a zone.

Parameters
[in]zoneId- The global zone identifier for which to request coordinates.
[in,out]coords- The preallocated data array of type float in which to store the coordinates.
[in]dataSize- The allocated size of the coords
Returns
- The actual size of the data read.
See also
startReadingCoordinatesForNodes, getCoordinatesForNode, getCoordinatesForNodesInRange, endReadingCoordinatesForNodes

◆ getDataOfConstantLengthVarForSetData()

bool ansys::CffProvider::getDataOfConstantLengthVarForSetData ( const int  nth,
void *const  vals,
size_t const  dataSize 
) const
virtual

◆ getDataOfVariableLengthVarForSetData()

bool ansys::CffProvider::getDataOfVariableLengthVarForSetData ( const int  nth,
void *const  vals,
size_t const  dataSize 
) const
virtual

◆ getDataTypeOfDataForSetData()

PlainDataType ansys::CffProvider::getDataTypeOfDataForSetData ( ) const
virtual

◆ getDataTypeOfSizeForSetData()

PlainDataType ansys::CffProvider::getDataTypeOfSizeForSetData ( ) const
virtual

◆ getFaceCountForCell()

short ansys::CffProvider::getFaceCountForCell ( const ElemIdType  cellId) const
virtual

◆ getFaceCountsForCellsInRange()

size_t ansys::CffProvider::getFaceCountsForCellsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
short *const  cfc,
const size_t  dataSize 
) const
virtual

◆ getFaceCountsForCellsInZone()

size_t ansys::CffProvider::getFaceCountsForCellsInZone ( const ZoneIdType  zoneId,
short *const  cfc,
const size_t  dataSize 
) const
virtual

◆ getFaceIdsForCell()

size_t ansys::CffProvider::getFaceIdsForCell ( const ElemIdType  cellId,
ElemIdType *const  cfid,
const size_t  dataSize 
) const
virtual

◆ getFaceIdsForCellsInRange()

size_t ansys::CffProvider::getFaceIdsForCellsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
ElemIdType *const  cfid,
const size_t  dataSize 
) const
virtual

◆ getFaceIdsForCellsInZone()

size_t ansys::CffProvider::getFaceIdsForCellsInZone ( const ZoneIdType  zoneId,
ElemIdType *const  cfid,
const size_t  dataSize 
) const
virtual

◆ getIdsForSetData()

bool ansys::CffProvider::getIdsForSetData ( const int  nth,
ElemIdType *const  setId,
const size_t  dataSize 
) const
virtual

◆ getIdsForSetInRange()

size_t ansys::CffProvider::getIdsForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
ElemIdType *const  setId,
const size_t  dataSize 
)
virtual

◆ getInjectionNames()

void ansys::CffProvider::getInjectionNames ( InjectionNames names) const
virtual

Particle Tracks

◆ getInterfaceDataForFace() [1/2]

size_t ansys::CffProvider::getInterfaceDataForFace ( const ElemIdType  faceId,
double * const  area,
const size_t  areaSize,
double * const  centroid,
const size_t  centroidSize,
size_t *const  pf0,
size_t * const  pf1 = NULL 
) const
virtual

◆ getInterfaceDataForFace() [2/2]

size_t ansys::CffProvider::getInterfaceDataForFace ( const ElemIdType  faceId,
float * const  area,
const size_t  areaSize,
float * const  centroid,
const size_t  centroidSize,
size_t *const  pf0,
size_t * const  pf1 = NULL 
) const
virtual

◆ getInterfaceDataForFacesInZone() [1/2]

size_t ansys::CffProvider::getInterfaceDataForFacesInZone ( const ZoneIdType  zoneId,
double * const  area,
const size_t  areaSize,
double * const  centroid,
const size_t  centroidSize,
size_t * const  pf0,
const size_t  pf0Size,
size_t * const  pf1 = NULL,
const size_t  pf1Size = 0 
) const
virtual

◆ getInterfaceDataForFacesInZone() [2/2]

size_t ansys::CffProvider::getInterfaceDataForFacesInZone ( const ZoneIdType  zoneId,
float * const  area,
const size_t  areaSize,
float * const  centroid,
const size_t  centroidSize,
size_t * const  pf0,
const size_t  pf0Size,
size_t * const  pf1 = NULL,
const size_t  pf1Size = 0 
) const
virtual

◆ getMeshBranchesWithParticleTracks()

void ansys::CffProvider::getMeshBranchesWithParticleTracks ( MeshIds meshId,
TargetCategories target,
PartitionIds partition 
)
virtual

Get all mesh branches that contain particle track data, each mesh branch is specified by a pair of three values: meshId, target and partition (only applicable to the situation that target is PARTITION_POST)

Parameters
[out]meshId- The mesh id specifies in which mesh branch to check if particle tack exists.
[out]target- The target category specifies in which mesh branch to check if particle tack exists.
[out]partition- The partition id specifies in which mesh branch to check if particle tack exists, only applicable when target is PARTITION_POST.

◆ getNodeCountForCell()

short ansys::CffProvider::getNodeCountForCell ( const ElemIdType  cellId) const
virtual

Get the node count for a sepcific cell.

This function must always be called after calling startReadingNodesForCells() and startReadingNodeCountsForCells().

Parameters
[in]cellId- The identifier of the cell to query.
Returns
- The number of nodes for the cell, or 0 if invalid cellId
See also
startReadingNodesForCells, startReadingNodeCountsForCells, startReadingNodeIdsForCells, getNodeIdsForCell, hasUniformNodeCountForCellsInRange, getNodeCountsForCellsInRange, getNodeIdsForCellsInRange, hasUniformNodeCountForCellsInZone, getNodeCountsForCellsInZone, getNodeIdsForCellsInZone, endReadingNodeCountsForCells, endReadingNodeIdsForCells,

◆ getNodeCountForEdge()

short ansys::CffProvider::getNodeCountForEdge ( const ElemIdType  edgeId) const
virtual

◆ getNodeCountForFace()

short ansys::CffProvider::getNodeCountForFace ( const ElemIdType  faceId) const
virtual

Get the node count for a sepcific face.

This function must always be called after calling startReadingNodesForFaces() and startReadingNodeCountsForFaces().

Parameters
[in]faceId- The identifier of the face to query.
Returns
- The number of nodes for the face, or 0 if invalid faceId
See also
startReadingNodesForFaces, startReadingNodeCountsForFaces, startReadingNodeIdsForFaces, getNodeIdsForFace, hasUniformNodeCountForFacesInRange, getNodeCountsForFacesInRange, getNodeIdsForFacesInRange, hasUniformNodeCountForFacesInZone, getNodeCountsForFacesInZone, getNodeIdsForFacesInZone, endReadingNodeCountsForFaces, endReadingNodeIdsForFaces,

◆ getNodeCountsForCellsInRange()

size_t ansys::CffProvider::getNodeCountsForCellsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
short *const  cnc,
const size_t  dataSize 
) const
virtual

Get the node counts for a range of cells.

This function must always be called after calling startReadingNodesForCells() and startReadingNodeCountsForCells().

Parameters
[in]minId- The identifier of the first cell to query.
[in]maxId- The identifier of the last cell to query.
[in,out]cnc- The preallocated array of type short large enough to hold all node counts for all cells in the range.
[in]dataSize- The allocated size of cnc
Returns
- The size of the data returned or 0 if invalid
See also
startReadingNodesForCells, startReadingNodeCountsForCells, startReadingNodeIdsForCells, getNodeCountForCell, getNodeIdsForCell, hasUniformNodeCountForCellsInRange, getNodeIdsForCellsInRange, hasUniformNodeCountForCellsInZone, getNodeCountsForCellsInZone, getNodeIdsForCellsInZone, endReadingNodeCountsForCells, endReadingNodeIdsForCells,

◆ getNodeCountsForCellsInZone()

size_t ansys::CffProvider::getNodeCountsForCellsInZone ( const ZoneIdType  zoneId,
short *const  cnc,
const size_t  dataSize 
) const
virtual

Get the node counts for all cells within a cell zone.

This function must always be called after calling startReadingNodesForCells() and startReadingNodeCountsForCells().

Parameters
[in]zoneId- The identifier of the cell zone to query.
[in,out]cnc- The preallocated array of type short large enough too hold all node counts for all cells in the zone zoneId.
[in]dataSize- The allocated size of cnc
Returns
- The size of the data returned or 0 if invalid
See also
startReadingNodesForCells, startReadingNodeCountsForCells, startReadingNodeIdsForCells, getNodeCountForCell, getNodeIdsForCell, hasUniformNodeCountForCellsInRange, getNodeIdsForCellsInRange, getNodeIdsForCellsInRange, hasUniformNodeCountForCellsInZone, getNodeIdsForCellsInZone, endReadingNodeIdsCountsForCells, endReadingNodesForCells

◆ getNodeCountsForEdgesInRange()

size_t ansys::CffProvider::getNodeCountsForEdgesInRange ( const  ElemIdType,
const  ElemIdType,
short * const  enc,
const size_t  dataSize 
) const
virtual

◆ getNodeCountsForEdgesInZone()

size_t ansys::CffProvider::getNodeCountsForEdgesInZone ( const ZoneIdType  zoneId,
short *const  fenc,
const size_t  dataSize 
) const
virtual

◆ getNodeCountsForFacesInRange()

size_t ansys::CffProvider::getNodeCountsForFacesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
short * const  fnc,
const size_t  dataSize 
) const
virtual

Get the node counts for a range of faces.

This function must always be called after calling startReadingNodesForFaces() and startReadingNodeCountsForFaces().

Parameters
[in]minId- The identifier of the first face to query.
[in]maxId- The identifier of the last face to query.
[in,out]fnc- A preallocated array of type short large enough all node counts for the range of faces.
[in]dataSize- The allocated size of fnc
Returns
- The size of the data returned or 0 if invalid
See also
startReadingNodesForFaces, startReadingNodeCountsForFaces, startReadingNodeIdsForFaces, getNodeCountForFace, getNodeIdsForFace, hasUniformNodeCountForFacesInRange, getNodeIdsForFacesInRange, hasUniformNodeCountForFacesInZone, getNodeCountsForFacesInZone, getNodeIdsForFacesInZone, endReadingNodeCountsForFaces, endReadingNodeIdsForFaces,

◆ getNodeCountsForFacesInZone()

size_t ansys::CffProvider::getNodeCountsForFacesInZone ( const ZoneIdType  zoneId,
short *const  fnc,
const size_t  dataSize 
) const
virtual

Get the node counts for all faces within a face zone.

This function must always be called after calling startReadingNodesForFaces() and startReadingNodeCountsForFaces().

Parameters
[in]zoneId- The identifier of the face zone to query.
[in,out]fnc- The preallocated array of type short large enough to hold the node count for all faces in the zone.
[in]dataSize- The allocated size of fnc
Returns
- The size of the data returned or 0 if invalid
See also
startReadingNodesForFaces, sstartReadingNodeCountsForFaces, startReadingNodeIdsForFaces, getNodeCountForFace, getNodeIdsForFace, hasUniformNodeCountForFacesInRange, getNodeIdsForFacesInRange, getNodeIdsForFacesInRange, hasUniformNodeCountForFacesInZone, getNodeCountsForFacesInZone, endReadingNodeCountsForFaces, endReadingNodeIdsForFaces,

◆ getNodeIdsForCell()

size_t ansys::CffProvider::getNodeIdsForCell ( const ElemIdType  cellId,
ElemIdType *const  cnid,
const size_t  dataSize 
) const
virtual

Get the node identifiers for a specific cell.

This function must always be called after calling startReadingNodesForCells() and startReadingNodeIdsForCells().

Parameters
[in]cellId- The cell identifier to query.
[in,out]cnid- The preallocated array of type ElemIdType large enough to hold all node identifiers for the cell.
[in]dataSize- The allocated size of cnid
Returns
- The size of the data returned or 0 if invalid
See also
startReadingNodesForCells, startReadingNodeCountsForCells, startReadingNodeIdsForCells, getNodeCountForCell, hasUniformNodeCountForCellsInRange, getNodeCountsForCellsInRange, getNodeIdsForCellsInRange, hasUniformNodeCountForCellsInZone, getNodeCountsForCellsInZone, getNodeIdsForCellsInZone, endReadingNodeCountsForCells, endReadingNodeIdsForCells

◆ getNodeIdsForCellsInRange()

size_t ansys::CffProvider::getNodeIdsForCellsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
ElemIdType *const  cnid,
const size_t  dataSize 
) const
virtual

Get the node identifiers for a range of cells.

This function must always be called after calling startReadingNodesForCells() and startReadingNodeIdsForCells().

Parameters
[in]minId- The identifier of the first cell to query.
[in]maxId- The identifier of the last cell to query.
[in,out]cnid- The preallocated array of type ElemIdType large enough to hold all node identifiers for all cells in the range.
[in]dataSize- The allocated size of cnid
Returns
- The size of the data returned or 0 if invalid
See also
startReadingNodesForCells, startReadingNodeCountsForCells, startReadingNodeIdsForCells, getNodeCountForCell, getNodeIdsForCell, hasUniformNodeCountForCellsInRange, getNodeCountsForCellsInRange, hasUniformNodeCountForCellsInZone, getNodeCountsForCellsInZone, getNodeIdsForCellsInZone, endReadingNodeCountsForCells, endReadingNodeIdsForCells,

◆ getNodeIdsForCellsInZone()

size_t ansys::CffProvider::getNodeIdsForCellsInZone ( const ZoneIdType  zoneId,
ElemIdType *const  cnid,
const size_t  dataSize 
) const
virtual

Get the node identifiers for all cells within a cell zone.

This function must always be called after calling startReadingNodesForCells() and startReadingNodeIdsForCells().

Parameters
[in]zoneId- The identifier of the cell zone to query.
[in,out]cnid- The preallocated array of type ElemIdType large enough too hold all node identifiers for all cells in the zone zoneId.
[in]dataSize- The allocated size of cnid
Returns
- The size of the data returned or 0 if invalid
See also
startReadingNodesForCells, startReadingNodeCountsForCells, startReadingNodeIdsForCells, getNodeCountForCell, getNodeIdsForCell, hasUniformNodeCountForCellsInRange, getNodeIdsForCellsInRange, getNodeIdsForCellsInRange, hasUniformNodeCountForCellsInZone, getNodeCountsForCellsInZone, endReadingNodeIdsCountsForCells, endReadingNodesForCells

◆ getNodeIdsForEdge()

size_t ansys::CffProvider::getNodeIdsForEdge ( const ElemIdType  edgeId,
ElemIdType *const  enid,
const size_t  dataSize 
) const
virtual

◆ getNodeIdsForEdgesInRange()

size_t ansys::CffProvider::getNodeIdsForEdgesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
ElemIdType * const  enid,
const size_t  dataSize 
) const
virtual

◆ getNodeIdsForEdgesInZone()

size_t ansys::CffProvider::getNodeIdsForEdgesInZone ( const ZoneIdType  zoneId,
ElemIdType * const  enid,
const size_t  dataSize 
) const
virtual

◆ getNodeIdsForFace()

size_t ansys::CffProvider::getNodeIdsForFace ( const ElemIdType  faceId,
ElemIdType *const  fnid,
const size_t  dataSize 
) const
virtual

Get the node identifiers for a specific face.

This function must always be called after calling startReadingNodesForFaces() and startReadingNodeIdsForFaces().

Parameters
[in]faceId- The identifier of the face to query.
[in,out]fnid- The preallocated array of type ElemIdType large enough to hold all nodes defining the face.
[in]dataSize- The size of the allocated array fnid.
Returns
- The number of nodes for the face, or 0 if invalid faceId
See also
startReadingNodesForFaces, startReadingNodeCountsForFaces, startReadingNodeIdsForFaces, getNodeIdsForFace, hasUniformNodeCountForFacesInRange, getNodeCountsForFacesInRange, getNodeIdsForFacesInRange, hasUniformNodeCountForFacesInZone, getNodeCountsForFacesInZone, getNodeIdsForFacesInZone, endReadingNodeCountsForFaces, endReadingNodeIdsForFaces,

◆ getNodeIdsForFacesInRange()

size_t ansys::CffProvider::getNodeIdsForFacesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
ElemIdType * const  fnid,
const size_t  dataSize 
) const
virtual

Get the node identifiers for a range of faces.

This function must always be called after calling startReadingNodesForFaces() and startReadingNodeIdsForFaces().

Parameters
[in]minId- The identifier of the first face to query.
[in]maxId- The identifier of the last face to query.
[in,out]fnid- The preallocated array of type ElemIdType large enough to hold all node identifiers for all faces in the range.
[in]dataSize- The allocated size of fnid
Returns
- The size of the data returned or 0 if invalid
See also
startReadingNodesForFaces, startReadingNodeCountsForFaces, startReadingNodeIdsForFaces, getNodeCountForFace, getNodeIdsForFace, hasUniformNodeCountForFacesInRange, getNodeIdsForFacesInRange, hasUniformNodeCountForFacesInZone, getNodeCountsForFacesInZone, getNodeIdsForFacesInZone, endReadingNodeCountsForFaces, endReadingNodeIdsForFaces,

◆ getNodeIdsForFacesInZone()

size_t ansys::CffProvider::getNodeIdsForFacesInZone ( const ZoneIdType  zoneId,
ElemIdType * const  fnid,
const size_t  dataSize 
) const
virtual

Get the node identifiers for a all faces within a face zone.

This function must always be called after calling startReadingNodesForFaces() and startReadingNodeIdsForFaces().

Parameters
[in]zoneId- The identifier of the face zone to query.
[in,out]fnid- The preallocated array of type ElemIdType large enough too hold all node identifiers for all faces in the zone zoneId.
[in]dataSize- The allocated size of fnid
Returns
- The size of the data returned or 0 if invalid
See also
startReadingNodesForFaces, startReadingNodeCountsForFaces, startReadingNodeIdsForFaces, getNodeCountForFace, getNodeIdsForFace, hasUniformNodeCountForFacesInRange, getNodeIdsForFacesInRange, getNodeIdsForFacesInRange, hasUniformNodeCountForFacesInZone, getNodeCountsForFacesInZone, endReadingNodeIdsCountsForFaces, endReadingNodesForFaces,

◆ getNumOfParticlesInInjection()

size_t ansys::CffProvider::getNumOfParticlesInInjection ( const InjectionName name) const
virtual

◆ getNumRowsOfSetData()

size_t ansys::CffProvider::getNumRowsOfSetData ( const int  nth) const
virtual

◆ getOtherDataForSetData()

bool ansys::CffProvider::getOtherDataForSetData ( void *const  vals,
size_t const  dataSize 
) const
virtual

◆ getOtherVariablesInSet()

void ansys::CffProvider::getOtherVariablesInSet ( VariableNames varNames) const
virtual

◆ getOtherVariablesInSetData()

void ansys::CffProvider::getOtherVariablesInSetData ( VariableNames varNames) const
virtual

◆ getParticleTrackGroups()

void ansys::CffProvider::getParticleTrackGroups ( std::vector< std::string > &  groupNames)
virtual

Get names of all particle track groups in current path.

Parameters
[out]groupNames- The particle track group names.

◆ getPartitionCount() [1/2]

int ansys::CffProvider::getPartitionCount ( ) const

Query the global number of partitions available.

Returns
- global number of partitions.
See also
hasPartition setPartition

◆ getPartitionCount() [2/2]

int ansys::CffProvider::getPartitionCount ( MeshIdType  meshId) const
virtual

Query the number of partitions available for a specific mesh.

Parameters
[in]meshId- the mesh for which to query the number of partitions.
Returns
- number of partitions in the mesh provided.
See also
hasPartition setPartition availablePartitionIds

◆ getPartitionCountForZone()

int ansys::CffProvider::getPartitionCountForZone ( const ZoneIdType  zoneId) const
virtual

◆ getPartitionIdForCell()

PartitionIdType ansys::CffProvider::getPartitionIdForCell ( const ElemIdType  cellId) const
virtual

◆ getPartitionIdsForCellsInRange()

size_t ansys::CffProvider::getPartitionIdsForCellsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
PartitionIdType *const  partIds,
const size_t  dataSize 
) const
virtual

◆ getPartitionIdsForCellsInZone()

size_t ansys::CffProvider::getPartitionIdsForCellsInZone ( const ZoneIdType  zoneId,
PartitionIdType *const  partIds,
const size_t  dataSize 
) const
virtual

◆ getPhasesWithParticleTracks()

std::vector< PhaseIdType > ansys::CffProvider::getPhasesWithParticleTracks ( const MeshIdType  meshId = -1,
const TargetCategory  target = TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN,
const PartitionIdType  partition = -1 
)
virtual

Get all phases that contain particle track data in mesh specified by mesh, target and partition.

If any of the last two arguments are not specified, the active/default target and active/default partition are used.

Parameters
[in]meshId- The mesh id specifies in which mesh branch to check if particle tack exists
[in]target- The target category specifies in which mesh branch to check if particle tack exists
[in]partition- The partition id specifies in which mesh branch to check if particle tack exists, only applicable when target is PARTITION_POST

◆ getPhaseVariableCountOfCategory()

size_t ansys::CffProvider::getPhaseVariableCountOfCategory ( const ZoneCategory  category) const
virtual

◆ getPhaseVariablesOfCategory() [1/2]

void ansys::CffProvider::getPhaseVariablesOfCategory ( const ZoneCategory  category,
VariableIds phaseVariables 
) const
virtual

◆ getPhaseVariablesOfCategory() [2/2]

void ansys::CffProvider::getPhaseVariablesOfCategory ( const ZoneCategory  category,
VariableNames phaseVariables 
) const
virtual

◆ getSetNames() [1/3]

bool ansys::CffProvider::getSetNames ( const DataClass  dataClass,
const ZoneCategory  cat,
std::vector< std::string > &  setNames 
) const
virtual

◆ getSetNames() [2/3]

bool ansys::CffProvider::getSetNames ( const DataClass  dataClass,
std::vector< std::string > &  setNames 
) const
virtual

◆ getSetNames() [3/3]

bool ansys::CffProvider::getSetNames ( std::vector< std::string > &  setNames) const
virtual

◆ getSetting()

CffSetting ansys::CffProvider::getSetting ( const std::string &  key = "Common",
DataClass  dataClass = DataClass::CFF_CASE,
const std::string &  rootName = CffBase::_defaultSettingsPath 
) const
virtual

Read contents of a settings data set as a ansys::CffSetting object.

Parameters
[in]key- The data set name to read.
[in]dataClass- The data source from which to read the dataset.
[in]rootName- Optionally supply the the path under which to find the dataset. By default this is CffBase::_defaultSettingsPath
See also
setReadAllSettings getSettingsKeys setKeyWordsForSettingsToBeRead

◆ getSettings()

CffVariant ansys::CffProvider::getSettings ( const DataClass  dataClass,
const std::string &  key,
const PhaseIdType  phaseId = 1 
) const

Return the value as a variable for a specific key in the Ansys Common Fluids Settings Data Model.

Parameters
[in]dataClassThe data source from which to read the keys.
[in]keyThe requested key.
[in]phaseIdOptionally supply the phase to which this key belongs
Returns
A variant value that can be used to obtain value in different data types
See also
setReadAllSettings getSettingsKeys setKeyWordsForSettingsToBeRead

◆ getSettingsKeys()

void ansys::CffProvider::getSettingsKeys ( DataClass  dataClass,
std::vector< std::string > &  keys 
) const
virtual

Return the keys that are available in the Physics Data Model.

Parameters
[in]dataClassThe data source from which to read the keys.
[out]keysThe available keys.
See also
setReadAllSettings setKeyWordsForSettingsToBeRead getSettings

◆ getSettingString()

void ansys::CffProvider::getSettingString ( DataClass  dataClass,
const std::string &  dataSetName,
std::string &  contents,
const std::string &  root = "" 
) const
virtual

Read settings from a data set as text.

Parameters
[in]dataClass- The data source from which to read the dataset.
[in]dataSetName- The data set name to read.
[out]contents- The contents of the dataset.
[in]root- Optionally supply the the path under which to find the dataset. By default this is CffBase::_defaultSettingsPath
See also
setReadAllSettings getSettingsKeys setKeyWordsForSettingsToBeRead

◆ getShadowFaceIdForFace()

ElemIdType ansys::CffProvider::getShadowFaceIdForFace ( const ElemIdType  faceId) const
virtual

◆ getShadowFaceIdsForFacesInRange()

size_t ansys::CffProvider::getShadowFaceIdsForFacesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
ElemIdType *const  shadowFaces,
const size_t  dataSize 
) const
virtual

◆ getShadowFaceIdsForFacesInZone()

size_t ansys::CffProvider::getShadowFaceIdsForFacesInZone ( const ZoneIdType  zoneId,
ElemIdType *const  shadowFaces,
const size_t  dataSize 
) const
virtual

◆ getSizeOfVariableLengthedVarForSetInRange() [1/3]

size_t ansys::CffProvider::getSizeOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
CountType *const  counts,
size_t const  dataSize 
) const
virtual

◆ getSizeOfVariableLengthedVarForSetInRange() [2/3]

size_t ansys::CffProvider::getSizeOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
int *const  counts,
size_t const  dataSize 
) const
virtual

◆ getSizeOfVariableLengthedVarForSetInRange() [3/3]

size_t ansys::CffProvider::getSizeOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
size_t *const  counts,
size_t const  dataSize 
) const
virtual

◆ getSizeOfVariableLengthVarForSetData()

bool ansys::CffProvider::getSizeOfVariableLengthVarForSetData ( const int  nth,
void *const  counts,
size_t const  dataSize 
) const
virtual

◆ getTypeForCell()

CellType ansys::CffProvider::getTypeForCell ( const ElemIdType  cellId) const
virtual

Query the type for a cell.

This function must always be called after calling startReadingTypesForCells().

Parameters
[in]cellId- The cell identiifier to query.
Returns
- The CellType of cellId or CFF_CELL_TYPE_MIN.
See also
startReadingTypesForCells, hasUniformTypeForCellsInZone, getTypesForCellsInRange, getTypesForCellsInZone, endReadingTypesForCells

◆ getTypesForCellsInRange()

size_t ansys::CffProvider::getTypesForCellsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
CellType * const  ct,
const size_t  dataSize 
) const
virtual

Obtain the types of all cells in a range.

This function must always be called after calling startReadingTypesForCells().

Parameters
[in]minId- The first cell in the range to query.
[in]maxId- The last cell in the range to query
[in,out]ct- The pre-allocated array of type CellTypeId large enough to hold a type for each cell in the range
[in]dataSize- The allocated size of ct.
Returns
- The number of valid values returned or 0
See also
startReadingTypesForCells, hasUnoformTypeForCellsInZone, getTypeForCell, getTypesForCellsInZone, endReadingTypesForCells

◆ getTypesForCellsInZone()

size_t ansys::CffProvider::getTypesForCellsInZone ( const ZoneIdType  zoneId,
CellType * const  ct,
const size_t  dataSize 
) const
virtual

Obtain the types of all cells in a cell zone.

This function must always be called after calling startReadingTypesForCells().

Parameters
[in]zoneId- The zone Id to query.
[in,out]ct- The pre-allocated array of type CellTypeId large enough to hold a type for each cell in the zone
[in]dataSize- The allocated size of ct.
Returns
- The number of valid values returned or 0
See also
startReadingTypesForCells, hasUnoformTypeForCellsInZone, getTypeForCell, getTypesForCellsInRange, endReadingTypesForCells

◆ getValuesOfConstantLengthedVarForSetInRange() [1/10]

size_t ansys::CffProvider::getValuesOfConstantLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
char *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfConstantLengthedVarForSetInRange() [2/10]

size_t ansys::CffProvider::getValuesOfConstantLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
double *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfConstantLengthedVarForSetInRange() [3/10]

size_t ansys::CffProvider::getValuesOfConstantLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
float *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfConstantLengthedVarForSetInRange() [4/10]

size_t ansys::CffProvider::getValuesOfConstantLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
int *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfConstantLengthedVarForSetInRange() [5/10]

size_t ansys::CffProvider::getValuesOfConstantLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
long *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfConstantLengthedVarForSetInRange() [6/10]

size_t ansys::CffProvider::getValuesOfConstantLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
long long *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfConstantLengthedVarForSetInRange() [7/10]

size_t ansys::CffProvider::getValuesOfConstantLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
short *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfConstantLengthedVarForSetInRange() [8/10]

size_t ansys::CffProvider::getValuesOfConstantLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
size_t *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfConstantLengthedVarForSetInRange() [9/10]

size_t ansys::CffProvider::getValuesOfConstantLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
unsigned char *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfConstantLengthedVarForSetInRange() [10/10]

size_t ansys::CffProvider::getValuesOfConstantLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
unsigned int *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfOtherVariableForSet() [1/10]

size_t ansys::CffProvider::getValuesOfOtherVariableForSet ( char *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfOtherVariableForSet() [2/10]

size_t ansys::CffProvider::getValuesOfOtherVariableForSet ( double *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfOtherVariableForSet() [3/10]

size_t ansys::CffProvider::getValuesOfOtherVariableForSet ( float *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfOtherVariableForSet() [4/10]

size_t ansys::CffProvider::getValuesOfOtherVariableForSet ( int *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfOtherVariableForSet() [5/10]

size_t ansys::CffProvider::getValuesOfOtherVariableForSet ( long *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfOtherVariableForSet() [6/10]

size_t ansys::CffProvider::getValuesOfOtherVariableForSet ( long long *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfOtherVariableForSet() [7/10]

size_t ansys::CffProvider::getValuesOfOtherVariableForSet ( short *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfOtherVariableForSet() [8/10]

size_t ansys::CffProvider::getValuesOfOtherVariableForSet ( size_t *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfOtherVariableForSet() [9/10]

size_t ansys::CffProvider::getValuesOfOtherVariableForSet ( unsigned char *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfOtherVariableForSet() [10/10]

size_t ansys::CffProvider::getValuesOfOtherVariableForSet ( unsigned int *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfPhaseVariableForElement() [1/2]

size_t ansys::CffProvider::getValuesOfPhaseVariableForElement ( const ElemIdType  elemId,
double *const  vals,
const size_t  dataSize 
) const
virtual

Read solution data for a single element within a zone that contains the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable.

Parameters
elemId[in] - The element for which the solution data is to be read.
vals[in] - A preallocated array of type double large enough to hold all components of the variable being read for elemId.
dataSize[in] - The allocated size of vals.
Returns
- 0 if the data isn't available for the requested element or the dataSize if successful.
See also
startReadingZonesOfCategoryWithPhaseVariable, getValuesOfPhaseVariableForElement, getValuesOfPhaseVariableForElementsInRange, getValuesOfPhaseVariableForElementsInZone, endReadingZonesOfCategoryWithPhaseVariable

◆ getValuesOfPhaseVariableForElement() [2/2]

size_t ansys::CffProvider::getValuesOfPhaseVariableForElement ( const ElemIdType  elemId,
float *const  vals,
const size_t  dataSize 
) const
virtual

Read solution data for a single element within a zone that contains the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable.

Parameters
elemId[in] - The element for which the solution data is to be read.
vals[in] - A preallocated array of type float large enough to hold all components of the variable being read for elemId.
dataSize[in] - The allocated size of vals.
Returns
- 0 if the data isn't available for the requested element or the dataSize if successful.
See also
startReadingZonesOfCategoryWithPhaseVariable, getValuesOfPhaseVariableForElement, getValuesOfPhaseVariableForElementsInRange, getValuesOfPhaseVariableForElementsInZone, endReadingZonesOfCategoryWithPhaseVariable

◆ getValuesOfPhaseVariableForElementsInRange() [1/2]

size_t ansys::CffProvider::getValuesOfPhaseVariableForElementsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
double *const  vals,
const size_t  dataSize 
) const
virtual

Read solution data for a range of elements for the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable.

Parameters
minId[in] - First element for which the solution data is to be read.
maxId[in] - Last element for which the solution data is to be read.
vals[in] - A preallocated array of type double large enough to hold all components of the variable for each element in the supplied range minId to maxId.
dataSize[in] - The allocated size of vals.
Returns
- 0 if the data isn't available for the requested element or the dataSize if successful.
See also
startReadingZonesOfCategoryWithPhaseVariable, getValuesOfPhaseVariableForElement, getValuesOfPhaseVariableForElementsInZone, endReadingZonesOfCategoryWithPhaseVariable

◆ getValuesOfPhaseVariableForElementsInRange() [2/2]

size_t ansys::CffProvider::getValuesOfPhaseVariableForElementsInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
float *const  vals,
const size_t  dataSize 
) const
virtual

Read solution data for a range of elements for the variable being requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable.

Parameters
minId[in] - First element for which the solution data is to be read.
maxId[in] - Last element for which the solution data is to be read.
vals[in] - A preallocated array of type float large enough to hold all components of the variable for each element in the supplied range minId to maxId.
dataSize[in] - The allocated size of vals.
Returns
- 0 if the data isn't available for the requested element or the dataSize if successful.
See also
startReadingZonesOfCategoryWithPhaseVariable, getValuesOfPhaseVariableForElement, getValuesOfPhaseVariableForElementsInZone, endReadingZonesOfCategoryWithPhaseVariable

◆ getValuesOfPhaseVariableForElementsInZone() [1/2]

size_t ansys::CffProvider::getValuesOfPhaseVariableForElementsInZone ( const ZoneIdType  zoneId,
double *const  vals,
const size_t  dataSize 
) const
virtual

Read solution data for a zone variable for all elements within a zone requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable.

Parameters
zoneId[in] - Zone identifier for which the solution data will be read
vals[in] - A preallocated array of type double large enough to hold all components of the variable for each element in the supplied zonee zoneId.
dataSize[in] - The allocated size of vals.
Returns
- 0 if the data isn't available for the requested element or the dataSize if successful.
See also
startReadingZonesOfCategoryWithPhaseVariable, getValuesOfPhaseVariableForElement, getValuesOfPhaseVariableForElementsInRange, endReadingZonesOfCategoryWithPhaseVariable

◆ getValuesOfPhaseVariableForElementsInZone() [2/2]

size_t ansys::CffProvider::getValuesOfPhaseVariableForElementsInZone ( const ZoneIdType  zoneId,
float *const  vals,
const size_t  dataSize 
) const
virtual

Read solution data for a zone variable for all elements within a zone requested by the previous call to startReadingZonesOfCategoryWithPhaseVariable.

Parameters
zoneId[in] - Zone identifier for which the solution data will be read
vals[in] - A preallocated array of type double large enough to hold all components of the variable for each element in the supplied zonee zoneId.
dataSize[in] - The allocated size of vals.
Returns
- 0 if the data isn't available for the requested element or the dataSize if successful.
See also
startReadingZonesOfCategoryWithPhaseVariable, getValuesOfPhaseVariableForElement, getValuesOfPhaseVariableForElementsInRange, endReadingZonesOfCategoryWithPhaseVariable

◆ getValuesOfVariableForParticlesInInjection() [1/10]

size_t ansys::CffProvider::getValuesOfVariableForParticlesInInjection ( char *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfVariableForParticlesInInjection() [2/10]

size_t ansys::CffProvider::getValuesOfVariableForParticlesInInjection ( double *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfVariableForParticlesInInjection() [3/10]

size_t ansys::CffProvider::getValuesOfVariableForParticlesInInjection ( ElemIdType *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfVariableForParticlesInInjection() [4/10]

size_t ansys::CffProvider::getValuesOfVariableForParticlesInInjection ( float *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfVariableForParticlesInInjection() [5/10]

size_t ansys::CffProvider::getValuesOfVariableForParticlesInInjection ( int *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfVariableForParticlesInInjection() [6/10]

size_t ansys::CffProvider::getValuesOfVariableForParticlesInInjection ( long *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfVariableForParticlesInInjection() [7/10]

size_t ansys::CffProvider::getValuesOfVariableForParticlesInInjection ( long long *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfVariableForParticlesInInjection() [8/10]

size_t ansys::CffProvider::getValuesOfVariableForParticlesInInjection ( short *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfVariableForParticlesInInjection() [9/10]

size_t ansys::CffProvider::getValuesOfVariableForParticlesInInjection ( unsigned char *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfVariableForParticlesInInjection() [10/10]

size_t ansys::CffProvider::getValuesOfVariableForParticlesInInjection ( unsigned int *const  vals,
size_t const  dataSize 
) const
virtual

◆ getValuesOfVariableLengthedVarForSetInRange() [1/10]

size_t ansys::CffProvider::getValuesOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
char *const  vals,
size_t const  dataSize = std::numeric_limits<size_t>::max() 
) const
virtual

◆ getValuesOfVariableLengthedVarForSetInRange() [2/10]

size_t ansys::CffProvider::getValuesOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
double *const  vals,
size_t const  dataSize = std::numeric_limits<size_t>::max() 
) const
virtual

◆ getValuesOfVariableLengthedVarForSetInRange() [3/10]

size_t ansys::CffProvider::getValuesOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
float *const  vals,
size_t const  dataSize = std::numeric_limits<size_t>::max() 
) const
virtual

◆ getValuesOfVariableLengthedVarForSetInRange() [4/10]

size_t ansys::CffProvider::getValuesOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
int *const  vals,
size_t const  dataSize = std::numeric_limits<size_t>::max() 
) const
virtual

◆ getValuesOfVariableLengthedVarForSetInRange() [5/10]

size_t ansys::CffProvider::getValuesOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
long *const  vals,
size_t const  dataSize = std::numeric_limits<size_t>::max() 
) const
virtual

◆ getValuesOfVariableLengthedVarForSetInRange() [6/10]

size_t ansys::CffProvider::getValuesOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
long long *const  vals,
size_t const  dataSize = std::numeric_limits<size_t>::max() 
) const
virtual

◆ getValuesOfVariableLengthedVarForSetInRange() [7/10]

size_t ansys::CffProvider::getValuesOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
short *const  vals,
size_t const  dataSize = std::numeric_limits<size_t>::max() 
) const
virtual

◆ getValuesOfVariableLengthedVarForSetInRange() [8/10]

size_t ansys::CffProvider::getValuesOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
size_t *const  vals,
size_t const  dataSize = std::numeric_limits<size_t>::max() 
) const
virtual

◆ getValuesOfVariableLengthedVarForSetInRange() [9/10]

size_t ansys::CffProvider::getValuesOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
unsigned char *const  vals,
size_t const  dataSize = std::numeric_limits<size_t>::max() 
) const
virtual

◆ getValuesOfVariableLengthedVarForSetInRange() [10/10]

size_t ansys::CffProvider::getValuesOfVariableLengthedVarForSetInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
unsigned int *const  vals,
size_t const  dataSize = std::numeric_limits<size_t>::max() 
) const
virtual

◆ getVariableDataOfAllParticleTracksInChunk() [1/10]

void ansys::CffProvider::getVariableDataOfAllParticleTracksInChunk ( char *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable in all particle tracks in the chunk.

Parameters
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfAllParticleTracksInChunk() [2/10]

void ansys::CffProvider::getVariableDataOfAllParticleTracksInChunk ( double *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable in all particle tracks in the chunk.

Parameters
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfAllParticleTracksInChunk() [3/10]

void ansys::CffProvider::getVariableDataOfAllParticleTracksInChunk ( float *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable in all particle tracks in the chunk.

Parameters
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfAllParticleTracksInChunk() [4/10]

void ansys::CffProvider::getVariableDataOfAllParticleTracksInChunk ( int *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable in all particle tracks in the chunk.

Parameters
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfAllParticleTracksInChunk() [5/10]

void ansys::CffProvider::getVariableDataOfAllParticleTracksInChunk ( long *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable in all particle tracks in the chunk.

Parameters
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfAllParticleTracksInChunk() [6/10]

void ansys::CffProvider::getVariableDataOfAllParticleTracksInChunk ( long long *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable in all particle tracks in the chunk.

Parameters
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfAllParticleTracksInChunk() [7/10]

void ansys::CffProvider::getVariableDataOfAllParticleTracksInChunk ( short *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable in all particle tracks in the chunk.

Parameters
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfAllParticleTracksInChunk() [8/10]

void ansys::CffProvider::getVariableDataOfAllParticleTracksInChunk ( size_t *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable in all particle tracks in the chunk.

Parameters
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfAllParticleTracksInChunk() [9/10]

void ansys::CffProvider::getVariableDataOfAllParticleTracksInChunk ( unsigned char *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable in all particle tracks in the chunk.

Parameters
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfAllParticleTracksInChunk() [10/10]

void ansys::CffProvider::getVariableDataOfAllParticleTracksInChunk ( unsigned int *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable in all particle tracks in the chunk.

Parameters
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfParticleTrackInChunk() [1/10]

void ansys::CffProvider::getVariableDataOfParticleTrackInChunk ( const ElemIdType  particleId,
char *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable within the specified particle within the active chunk.

Parameters
[in]particleId- Particle id
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfParticleTrackInChunk() [2/10]

void ansys::CffProvider::getVariableDataOfParticleTrackInChunk ( const ElemIdType  particleId,
double *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable within the specified particle within the active chunk.

Parameters
[in]particleId- Particle id
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfParticleTrackInChunk() [3/10]

void ansys::CffProvider::getVariableDataOfParticleTrackInChunk ( const ElemIdType  particleId,
float *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable within the specified particle within the active chunk.

Parameters
[in]particleId- Particle id
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfParticleTrackInChunk() [4/10]

void ansys::CffProvider::getVariableDataOfParticleTrackInChunk ( const ElemIdType  particleId,
int *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable within the specified particle within the active chunk.

Parameters
[in]particleId- Particle id
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfParticleTrackInChunk() [5/10]

void ansys::CffProvider::getVariableDataOfParticleTrackInChunk ( const ElemIdType  particleId,
long *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable within the specified particle within the active chunk.

Parameters
[in]particleId- Particle id
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfParticleTrackInChunk() [6/10]

void ansys::CffProvider::getVariableDataOfParticleTrackInChunk ( const ElemIdType  particleId,
long long *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable within the specified particle within the active chunk.

Parameters
[in]particleId- Particle id
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfParticleTrackInChunk() [7/10]

void ansys::CffProvider::getVariableDataOfParticleTrackInChunk ( const ElemIdType  particleId,
short *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable within the specified particle within the active chunk.

Parameters
[in]particleId- Particle id
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfParticleTrackInChunk() [8/10]

void ansys::CffProvider::getVariableDataOfParticleTrackInChunk ( const ElemIdType  particleId,
size_t *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable within the specified particle within the active chunk.

Parameters
[in]particleId- Particle id
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfParticleTrackInChunk() [9/10]

void ansys::CffProvider::getVariableDataOfParticleTrackInChunk ( const ElemIdType  particleId,
unsigned char *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable within the specified particle within the active chunk.

Parameters
[in]particleId- Particle id
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableDataOfParticleTrackInChunk() [10/10]

void ansys::CffProvider::getVariableDataOfParticleTrackInChunk ( const ElemIdType  particleId,
unsigned int *const  data,
const size_t  dataSize 
)
virtual

Get data for the variable within the specified particle within the active chunk.

Parameters
[in]particleId- Particle id
[in]dataSize- Size of data array.
[out]data- The buffer the data array will be returned in.

◆ getVariableId() [1/3]

bool ansys::CffProvider::getVariableId ( const PhaseName phaseName,
const VariableName varName,
VariableIdType varId 
) const

Obtain the unique name associated with a variable Id in supplied phase

Parameters
[in]phaseName- Phase Name in which to locate variable
[in]varName- Variable Name
[out]varId- Variable Id if valid, undefined otherwise
Returns
- true if a valid variable, false otherwise

◆ getVariableId() [2/3]

bool ansys::CffProvider::getVariableId ( const VariableName varName,
VariableIdType varId 
) const

Obtain the unique name associated with a variable Id in active phase.

Parameters
[in]varName- Variable Name
[out]varId- Variable Id if valid, undefined otherwise
Returns
- true if a valid variable, false otherwise

◆ getVariableId() [3/3]

bool ansys::CffProvider::getVariableId ( PhaseIdType  phaseId,
const VariableName varName,
VariableIdType varId 
) const

Obtain the unique name associated with a variable Id in supplied phase

Parameters
[in]phaseId- Phase in which to find the variable
[in]varName- Variable Name
[out]varId- Variable Id if valid, undefined otherwise
Returns
- true if a valid variable, false otherwise

◆ getVariablesInSet()

void ansys::CffProvider::getVariablesInSet ( VariableNames varNames,
std::vector< bool > &  hasSize 
) const
virtual

◆ getVariablesInSetData()

void ansys::CffProvider::getVariablesInSetData ( VariableNames varNames,
std::vector< bool > &  hasSize 
) const
virtual

◆ getVariablesOfInjection() [1/2]

void ansys::CffProvider::getVariablesOfInjection ( const InjectionName name,
VariableIds varIds 
) const
virtual

◆ getVariablesOfInjection() [2/2]

void ansys::CffProvider::getVariablesOfInjection ( const InjectionName name,
VariableNames varNames 
) const
virtual

◆ getVariablesOfParticleTrack()

void ansys::CffProvider::getVariablesOfParticleTrack ( std::vector< VariableName > &  varNames,
std::vector< bool > &  isConst,
std::vector< PlainDataType > &  dataTypes 
)
virtual

Get all variables in the particle track group.

Information for each variable is returned in a consistently indexed array.

Parameters
[out]varNames- The variable names available in the track.
[out]isConst- For each variable a flags indicating whether it is constant (i.e. does not change as a function of tracks step).
[out]dataTypes- For each variable the data type of the variable.

◆ hasMeshId()

bool ansys::CffProvider::hasMeshId ( MeshIdType  meshId) const
virtual

Determine whether a specific mesh exists.

Parameters
[in]meshId- The target category to query.
Returns
- true if the mesh exists.
See also
availableMeshIds

◆ hasParticles() [1/3]

bool ansys::CffProvider::hasParticles ( ) const
virtual

◆ hasParticles() [2/3]

bool ansys::CffProvider::hasParticles ( const PhaseIdType  phaseId) const
virtual

◆ hasParticles() [3/3]

bool ansys::CffProvider::hasParticles ( const PhaseName phaseName) const
virtual

◆ hasParticleTracks() [1/3]

bool ansys::CffProvider::hasParticleTracks ( )
virtual

Check if there are any particle tracks.

◆ hasParticleTracks() [2/3]

bool ansys::CffProvider::hasParticleTracks ( const MeshIdType  meshId,
const TargetCategory  target = TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN,
const PartitionIdType  partition = -1 
)
virtual

Check whether particular particle tracks exist.

Parameters
[in]meshId- The mesh id
[in]target- The target category
[in]partition- The partition id

◆ hasParticleTracks() [3/3]

bool ansys::CffProvider::hasParticleTracks ( const PhaseIdType  phaseId,
const MeshIdType  meshId,
const TargetCategory  target = TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN,
const PartitionIdType  partition = -1 
)
virtual

Check whether partucular particle tracks exist.

Parameters
[in]phaseId- The phase id
[in]meshId- The mesh id
[in]target- The target category
[in]partition- The partition id

◆ hasParticleTracksInActivePhase()

bool ansys::CffProvider::hasParticleTracksInActivePhase ( )
virtual

Check if there are particle track data in active phase of active mesh set.

◆ hasPartition() [1/2]

bool ansys::CffProvider::hasPartition ( MeshIdType  meshId,
PartitionIdType  pId 
) const
virtual

Query if the partition exists for specific mesh.

Parameters
[in]meshId- The mesh id to query within.
[in]pId- The partition to query.
Returns
- true if exists in the mesh, false otherwise.

◆ hasPartition() [2/2]

bool ansys::CffProvider::hasPartition ( PartitionIdType  pId) const

Query if the partition exists for any mesh.

Parameters
[in]pId- The partition to query.
Returns
- true if exists, false otherwise.

◆ hasTarget() [1/2]

bool ansys::CffProvider::hasTarget ( MeshIdType  meshId,
TargetCategory  target 
) const
virtual

Determine whether a specified mesh can be read using the target category.

Parameters
[in]meshId- The identifier of the mesh to query.
[in]target- The target category to query.
Returns
- True if the mesh mesh is defined in the category
See also
availableTargets

◆ hasTarget() [2/2]

bool ansys::CffProvider::hasTarget ( TargetCategory  target) const

Determine whether the any mesh can be read using the target category.

Parameters
[in]target- The target category to query.
Returns
- True if at least one mesh is defined in the category
See also
availableTargets

◆ hasUniformCaseSectionDataCountForZone()

bool ansys::CffProvider::hasUniformCaseSectionDataCountForZone ( const ZoneIdType  zoneId,
short *const  dc 
) const
virtual

◆ hasUniformFaceCountForCellsInZone()

bool ansys::CffProvider::hasUniformFaceCountForCellsInZone ( const ZoneIdType  zoneId,
short *const  ucfc 
) const
virtual

◆ hasUniformNodeCountForCellsInZone()

bool ansys::CffProvider::hasUniformNodeCountForCellsInZone ( const ZoneIdType  zoneId,
short *const  ucnc 
) const
virtual

Query whether all cells in the cell zone are defined using a uniform node count.

This function must always be called after calling startReadingNodesForCell() and startReadingNodeCountsForCells().

Parameters
[in]zoneId- The zone identifier to query.
[out]ucnc- If all cells are uniform in node count, the node count, undefined otherwise
Returns
- true if all cells have the same node count, else false
See also
startReadingNodesForCells, startReadingNodeCountsForCells, startReadingNodeIdsForCells, getNodeCountForCell, getNodeIdsForCell, getNodeCountsForCellsInRange, getNodeIdsForCellsInRange, hasUniformNodeCountForCellsInZone, getNodeCountsForCellsInZone, getNodeIdsForCellsInZone, endReadingNodeCountsForCells, endReadingNodeIdsForCells,

◆ hasUniformNodeCountForEdgesInRange()

bool ansys::CffProvider::hasUniformNodeCountForEdgesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
short *const  uenc 
) const
virtual

◆ hasUniformNodeCountForEdgesInZone()

bool ansys::CffProvider::hasUniformNodeCountForEdgesInZone ( const ZoneIdType  zoneId,
short *const  uenc 
) const
virtual

◆ hasUniformNodeCountForFacesInRange()

bool ansys::CffProvider::hasUniformNodeCountForFacesInRange ( const ElemIdType  minId,
const ElemIdType  maxId,
short *const  ufnc 
) const
virtual

Query whether all faces in the face range are defined using a uniform node count. i.e. are all the same type.

This function must always be called after calling startReadingNodesForFaces() and startReadingNodeCountsForFaces().

Parameters
[in]minId- The first face identifier to check.
[in]maxId- The last face identifier to check.
[out]ufnc- If all faces are uniform in node count, the node count, undefined otherwise
Returns
- true if all faces have the same node count, else false
See also
startReadingNodesForFaces, startReadingNodeCountsForFaces, startReadingNodeIdsForFaces, getNodeCountForFace, getNodeIdsForFace, getNodeCountsForFacesInRange, getNodeIdsForFacesInRange, hasUniformNodeCountForFacesInZone, getNodeCountsForFacesInZone, getNodeIdsForFacesInZone, endReadingNodeCountsForFaces, endReadingNodeIdsForFaces,

◆ hasUniformNodeCountForFacesInZone()

bool ansys::CffProvider::hasUniformNodeCountForFacesInZone ( const ZoneIdType  zoneId,
short *const  ufnc 
) const
virtual

Query whether all faces in the face zone are defined using a uniform node count. i.e. are all the same type.

This function must always be called after calling startReadingNodesForFaces() and startReadingNodeCountsForFaces().

Parameters
[in]zoneId- The identifier of the face zone to check.
[out]ufnc- If all faces are uniform in node count, the node count, undefined otherwise
Returns
- true if all faces have the same node count, else false
See also
startReadingNodesForFaces, startReadingNodeCountsForFaces, startReadingNodeIdsForFaces, getNodeCountForFace, getNodeIdsForFace, hasUniformNodeCountForFacesInRange, getNodeCountsForFacesInRange, getNodeIdsForFacesInRange, getNodeCountsForFacesInZone, getNodeIdsForFacesInZone, endReadingNodeCountsForFaces, endReadingNodeIdsForFaces,

◆ hasUniformTypeForCellsInZone()

bool ansys::CffProvider::hasUniformTypeForCellsInZone ( const ZoneIdType  zoneId,
CellType * const  uct 
) const
virtual

Query whether all cells in the cell zone have the same cell type.

This function must always be called after calling startReadingTypesForCells().

Parameters
[in]zoneId- The cell zone to query.
[out]uct- The uniform CellType or CFF_CELL_TYPE_MIN.
Returns
- true if all cells have the same type, else false
See also
startReadingTypesForCells, getTypeForCell, getTypesForCellsInRange, getTypesForCellsInZone, endReadingTypesForCells

◆ isReading()

bool ansys::CffProvider::isReading ( DataClass  dataClass) const
virtual

Return whether a reading of the class of data specified is possible.

Parameters
dataClass[in] - The class of data to query.
Returns
- true if data is readable, false otherwirse.
See also
startReading, endReading

◆ isReadingData()

bool ansys::CffProvider::isReadingData ( ) const

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

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

◆ print()

void ansys::CffProvider::print ( bool  objectOnly = true) const
virtual

Dump all setting key/value pairs to standard out.

This debugging function allows the settings model contents to be written to standard output.

Parameters
[in]objectOnly- If true, only dump object lists.

◆ setHeavyDataCacheMode()

void ansys::CffProvider::setHeavyDataCacheMode ( const DataCacheMode  cacheMode)
virtual

Set whether heavy weight data is cached within the API when read from the database. This function should be called prior to ansys::CffProvider::startReading.

Parameters
[in]cacheMode- CFF_NO_HEAVY_DATA_CACHE (no caching), CFF_ALLOW_HEAVY_DATA_CACHE (full caching)

Note: Not all subclasses will implement this function and calling this function in these cases. The motivation of providing this option is to speed up data reading for certain situation. In certain situation, user might need to read small amount of data each time but do many times of reading to read all data in a dataset. As accessing of the disk is usually much slower than accessing memory. So when "heavy weight data cache" is turned on, CFF SDK will read more data than requested by API call, the extra data read from file will be cached in memory, if the next API call is to retrieve these data already cached in memory, CFF SDK will get them directly from the memory without accessing the disk. In this way, avoid too frequent accessing of disk. This feature is recommended to use for the situation that all of the following conditions satisfied 1) Data of multiple zones are written into one dataset in cff file, the cff files written by Fluent is usually like this. For cff files written by other Ansys products, each zone is in a separate data set, so there is no performance benefit to use this option. 2) There are many small zones. The up limit of data caching is 50 MB, if the data of each zone is more than 20 MB, there will no performance benefit to use this option. 3) The order you read the data is from small element id to large element ids. So if you need to read data in random order, this option is not suitable.

See also
startReading

◆ setKeyWordsForSettingsToBeRead()

void ansys::CffProvider::setKeyWordsForSettingsToBeRead ( const std::vector< std::string > &  dsNames,
const std::vector< std::vector< std::string > > &  settings 
)
virtual

Limit the key words to be read into a Ansys Common Fluids Settings Data Model.

By default all settings datasets are read, parsed and the settings data model is populated with the all settings in that data set.

If only certain settings are required this function can be called with the data set names that should be read and the keys that are required from each dataset.

This function should be called before ansys::CffProvider::startReading

Note: The keys for dsNames[n] are defined by the list of strings in settings[n]

Parameters
[in]dsNamesThe list of datasets names that should be read.
[in]settingsThe keys for each dataset that should be read.
See also
startReading setReadAllSettings getSettings getSettingsKeys

◆ setReadAllSettings()

void ansys::CffProvider::setReadAllSettings ( bool  readAllSettings)
virtual

Turn on whether settings are read into a Ansys Common Fluids Settings Data Model.

This function should be called before calling ansys::CffProvider::startReading

Parameters
[in]readAllSettings- true if all settings are to be read, false otherwise.

Note: the default is to read all settings on read.

See also
setKeywordsForSettingsToRead startReading

◆ setReading()

void ansys::CffProvider::setReading ( DataClass  dataClass,
bool  readable 
)
protected

Set whether a reading of the class of data specified is possible.

Parameters
dataClass[in] - The class of data to modify the setting.
reading[in] - true if readable, false otherwirse.
See also
startReading, endReading

◆ setSkipReadZoneTopology()

void ansys::CffProvider::setSkipReadZoneTopology ( bool  skip)
virtual

Set whether mesh zone to mesh zone topology topology should be constructed when the case data is read. It should be called prior to calling ansys::CffProvider::startReading.

Parameters
[in]skip- If true, the topology is not constructed on read.

Note: Not all subclasses will implement this function and not all solvers write write data where this operation is needed.

See also
startReading

◆ setVariableRecipeProvider()

void ansys::CffProvider::setVariableRecipeProvider ( CffVariableRecipeProvider *  vrp)
virtual

Function allowing a user of the API to provide a Variable Recipe Provider that interprets data in a particular way.

This function should be called before calling ansys::CffProvider::startReading

Parameters
[in]vrp- The variable recipe provider that interprets the data that is associated with the "Recipe" given for specific solution variables.
See also
startReading

◆ setVariableTarget()

void ansys::CffProvider::setVariableTarget ( const VariableTarget varTarget)
virtual

Sets the target variable naming convention.

Variables written by an application will in general be written in the applications native dialog. In order too provide a method to allow the user to see variables from multiple applications with common nammes it is possible to define the target naming convention using this function.

Parameters
[in]varTarget- The string representing the variable naming convention that the CFFAPI should use.

Note: There is no need to use this function if the native convention is used.

Note: Use ANSYS_COMMON to map to a common naming covention.

See also
startReading

◆ startReading()

bool ansys::CffProvider::startReading ( DataClass  dataClass)
virtual

Reimplemented in ansys::CffFileProvider.

◆ startReadingCaseSectionData()

void ansys::CffProvider::startReadingCaseSectionData ( ) const
virtual

◆ startReadingCaseSectionDataCounts()

void ansys::CffProvider::startReadingCaseSectionDataCounts ( ) const
virtual

◆ startReadingCaseSectionForCategory()

PlainDataType ansys::CffProvider::startReadingCaseSectionForCategory ( const CategoryName catgeory,
ZoneIds zoneIds 
) const
virtual

◆ startReadingCategorizedCaseSections()

void ansys::CffProvider::startReadingCategorizedCaseSections ( const ZoneCategory  zoneCategory,
CategoryNames categories 
) const
virtual

◆ startReadingCell0sForFaces()

void ansys::CffProvider::startReadingCell0sForFaces ( ZoneIds zoneIds) const
virtual

Start reading the cell 0 parents.

This function must always be called before calling getCell0ForFace(), getCell0sForFacesInRange(), getCell0sForFacesInZone()

See also
getCell0ForFace, getCell0sForFacesInRange, getCell0sForFacesInZone, endReadingCell0sForFaces,

◆ startReadingCell1sForFaces()

void ansys::CffProvider::startReadingCell1sForFaces ( ZoneIds zoneIds) const
virtual

Start reading the cell 1 parents.

This function must always be called before calling getCell1ForFace(), getCell1sForFacesInRange(), getCell1sForFacesInZone()

See also
getCell1ForFace, getCell1sForFacesInRange, getCell1sForFacesInZone, endReadingCell1sForFaces,

◆ startReadingChildCellCountsForCells()

void ansys::CffProvider::startReadingChildCellCountsForCells ( ) const
virtual

◆ startReadingChildCellIdsForCells()

void ansys::CffProvider::startReadingChildCellIdsForCells ( ) const
virtual

◆ startReadingChildCellsForCells()

void ansys::CffProvider::startReadingChildCellsForCells ( ZoneIds zoneIds) const
virtual

◆ startReadingChildFaceCountsForFaces()

void ansys::CffProvider::startReadingChildFaceCountsForFaces ( ) const
virtual

◆ startReadingChildFaceIdsForFaces()

void ansys::CffProvider::startReadingChildFaceIdsForFaces ( ) const
virtual

◆ startReadingChildFacesForFaces()

void ansys::CffProvider::startReadingChildFacesForFaces ( ZoneIds zoneIds) const
virtual

◆ startReadingChunkInParticleTrackGroup()

size_t ansys::CffProvider::startReadingChunkInParticleTrackGroup ( const size_t  chunkIndex = 0)
virtual

Start reading the specified chunk within the particle track group.

Parameters
[in]chunkIndex- The index of the chunk to read.
Returns
- The total number of particles in the chunk.

◆ startReadingConstantLengthedVarForSet()

size_t ansys::CffProvider::startReadingConstantLengthedVarForSet ( const VariableName varName,
PlainDataType dataType 
) const
virtual

◆ startReadingConstantLengthVarForSetData()

size_t ansys::CffProvider::startReadingConstantLengthVarForSetData ( const VariableName varName) const
virtual

◆ startReadingCoordinatesForNodes()

void ansys::CffProvider::startReadingCoordinatesForNodes ( ZoneIds zoneIds) const
virtual

Determine the node zones for which coordinates have been defined and prepare to read the coordinates for those zones.

To read the coordinates for a specific node, specified node range or all nodes within a node 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 nodal coordinates;

// Create the provider
ansys::CffProvider* provider = ...;
provider->startReading(ansys::DataClass::CFF_CASE);

// Obtain the zones containing coordinates ansys::ZoneIds nodeZones; provider->startReadingCoordinatesForNodes(nodeZones);

if (!nodeZones.empty()) { // Determine the size of the expected data from the zone size and dimension ansys::ElemIdType sz = 0, dim = 0; provider->getZoneSizeInfo(nodeZones[0], CFF_ZONE_SIZE, sz); provider->getZoneSizeInfo(nodeZones[0], CFF_ZONE_DIMENSION, dim);

// Allocate the memory - here we request double precision coordinates double* coords = new double[szdim]; size_t numRead = provider->getCoordinatesForNodesInZone(nodeZones[0], coords, szdim);

// coords will contain X1, Y1, Z1, X2, Y2, Z2..., Xn, Yn, Zn for a 3 dimensional zone. }

// Finish reading node coordinates provider->endReadingCoordinatesForNodes();

// Finish reading the case data provider->endReading(ansys::DataClass::CFF_CASE);

Coordinates can be returned as either single or double precision depending on the functions called.

Parameters
[out]zoneIds- The zone Ids for which coordinates have been defined.

This function must always be called before calling the functions to read the actual node coordinates.

See also
getCoordinatesForNode, getCoordinatesForNodesInRange, getCoordinatesForNodesInZone, endReadingCoordinatesForNodes

◆ startReadingDataOfVariableLengthedVarForSet()

void ansys::CffProvider::startReadingDataOfVariableLengthedVarForSet ( ) const
virtual

◆ startReadingDataOfVariableLengthVarForSetData()

size_t ansys::CffProvider::startReadingDataOfVariableLengthVarForSetData ( ) const
virtual

◆ startReadingFaceCountsForCells()

void ansys::CffProvider::startReadingFaceCountsForCells ( ) const
virtual

◆ startReadingFaceIdsForCells()

void ansys::CffProvider::startReadingFaceIdsForCells ( ) const
virtual

◆ startReadingFacesForCells()

void ansys::CffProvider::startReadingFacesForCells ( ZoneIds zoneIds) const
virtual

◆ startReadingIdsForSet()

void ansys::CffProvider::startReadingIdsForSet ( std::vector< size_t > &  nElems,
std::vector< ElemIdType > &  minId,
std::vector< ElemIdType > &  maxId 
)
virtual

◆ startReadingIdsForSetData()

size_t ansys::CffProvider::startReadingIdsForSetData ( )
virtual

◆ startReadingInterfaceDataForFaces()

void ansys::CffProvider::startReadingInterfaceDataForFaces ( ZoneIds zoneIds,
std::vector< int > &  haspf1 
) const
virtual

◆ startReadingNodeCountsForCells()

void ansys::CffProvider::startReadingNodeCountsForCells ( ) const
virtual

◆ startReadingNodeCountsForEdges()

void ansys::CffProvider::startReadingNodeCountsForEdges ( ) const
virtual

◆ startReadingNodeCountsForFaces()

◆ startReadingNodeIdsForCells()

void ansys::CffProvider::startReadingNodeIdsForCells ( ) const
virtual

◆ startReadingNodeIdsForEdges()

void ansys::CffProvider::startReadingNodeIdsForEdges ( ) const
virtual

◆ startReadingNodeIdsForFaces()

◆ startReadingNodesForCells()

void ansys::CffProvider::startReadingNodesForCells ( ZoneIds zoneIds) const
virtual

Determine the cell zones for which nodes have been defined and prepare to read the nodes for those zones.

Parameters
[out]zoneIds- The zone identifiers for which nodes have been defined.

This function must always be called before calling the functions to read the actual cell node counts or cell nodes.

See also
startReadingNodeCountsForCells, startReadingNodeIdsForCells, getNodeCountForCell, getNodeIdsForCell, hasUniformNodeCountForCellsInRange, getNodeCountsForCellsInRange, getNodeIdsForCellsInRange, hasUniformNodeCountForCellsInZone, getNodeCountsForCellsInZone, getNodeIdsForCellsInZone, endReadingNodeCountsForCells, endReadingNodeIdsForCells, endReadingNodesForCells

◆ startReadingNodesForEdges()

void ansys::CffProvider::startReadingNodesForEdges ( ZoneIds zoneIds) const
virtual

◆ startReadingNodesForFaces()

void ansys::CffProvider::startReadingNodesForFaces ( ZoneIds zoneIds) const
virtual

Determine the face zones for which nodes have been defined and prepare to read the nodes for those zones.

Parameters
[out]zoneIds- The zone Ids for which nodes have been defined.

This function must always be called before calling the functions to read the actual face node counts or face nodes.

See also
startReadingNodeCountsForFaces, startReadingNodeIdsForFaces, getNodeCountForFace, getNodeIdsForFace, hasUniformNodeCountForFacesInRange, getNodeCountsForFacesInRange, getNodeIdsForFacesInRange, hasUniformNodeCountForFacesInZone, getNodeCountsForFacesInZone, getNodeIdsForFacesInZone, endReadingNodeCountsForFaces, endReadingNodeIdsForFaces, endReadingNodesForFaces

◆ startReadingOtherDataForSetData()

size_t ansys::CffProvider::startReadingOtherDataForSetData ( const VariableName varName,
PlainDataType dataType,
size_t &  numElems 
) const
virtual

◆ startReadingOtherVariableForSet()

size_t ansys::CffProvider::startReadingOtherVariableForSet ( const VariableName varName,
PlainDataType dataType,
size_t &  numElems 
) const
virtual

◆ startReadingParticles() [1/3]

bool ansys::CffProvider::startReadingParticles ( ) const
virtual

◆ startReadingParticles() [2/3]

bool ansys::CffProvider::startReadingParticles ( const PhaseIdType  phaseId) const
virtual

◆ startReadingParticles() [3/3]

bool ansys::CffProvider::startReadingParticles ( const PhaseName phaseName) const
virtual

◆ startReadingParticleTrackGroup()

size_t ansys::CffProvider::startReadingParticleTrackGroup ( const std::string &  groupName)
virtual

Start reading a specific particle track group.

Parameters
[in]groupName- The particle track group name.

◆ startReadingParticleTracks()

void ansys::CffProvider::startReadingParticleTracks ( const PhaseIdType  phaseId = -1,
const MeshIdType  meshId = -1,
const TargetCategory  target = TargetCategory::CFF_TARGET_CATEGORY_UNKNOWN,
const PartitionIdType  partition = -1 
)
virtual

Start reading particle tracks by phase in the mesh, target and partition.

If any of them are not specified, the current active value will be used.

Parameters
[in]phaseId- Phase from which particle track will be read.
[in]meshId- Mesh from which particle track will be read.
[in]target- Target category from which particle track will be read.
[in]partition- Partition from which particle track will be read, (only applicable when target is PARTITION_POST)

◆ startReadingPartitionIdsForCells()

void ansys::CffProvider::startReadingPartitionIdsForCells ( ZoneIds ) const
virtual

◆ startReadingPhase()

void ansys::CffProvider::startReadingPhase ( const PhaseIdType  phaseId = 1) const
virtual

Phases and Phase Attributes

◆ startReadingSet()

bool ansys::CffProvider::startReadingSet ( const DataClass  dataClass,
const ZoneCategory  cat,
const std::string &  setName 
)
virtual

◆ startReadingSetData()

bool ansys::CffProvider::startReadingSetData ( const DataClass  dataClass,
const ZoneCategory  cat,
const std::string &  setName 
)
virtual

◆ startReadingShadowFaceIdsForFaces()

void ansys::CffProvider::startReadingShadowFaceIdsForFaces ( ZoneIds zoneIds) const
virtual

◆ startReadingSizeOfVariableLengthedVarForSet()

PlainDataType ansys::CffProvider::startReadingSizeOfVariableLengthedVarForSet ( ) const
virtual

◆ startReadingSizeOfVariableLengthVarForSetData()

size_t ansys::CffProvider::startReadingSizeOfVariableLengthVarForSetData ( ) const
virtual

◆ startReadingTimeLevel()

void ansys::CffProvider::startReadingTimeLevel ( const TimeLevelType  timeLevel = CffFinalTimeLevel) const

◆ startReadingTypesForCells()

void ansys::CffProvider::startReadingTypesForCells ( ZoneIds zoneIds) const
virtual

Determine the cell zones for which cell types have been defined and prepare to read the cell types for those zones.

Parameters
[out]zoneIds- The zone Ids for which types have been defined.

This function must always be called before calling the functions to read the actual cell types.

See also
hasUniformTypeForCellsInZone, getTypeForCell, getTypesForCellsInRange, getTypesForCellsInZone, endReadingTypesForCells

◆ startReadingVariableForParticlesInInjection()

size_t ansys::CffProvider::startReadingVariableForParticlesInInjection ( const InjectionName injName,
const VariableName varName,
PlainDataType dataType 
) const
virtual

◆ startReadingVariableLengthedVarForSet()

void ansys::CffProvider::startReadingVariableLengthedVarForSet ( const VariableName varName,
PlainDataType dataType 
)
virtual

◆ startReadingVariableLengthVarForSetData()

void ansys::CffProvider::startReadingVariableLengthVarForSetData ( const VariableName varName)
virtual

◆ startReadingVariableOfParticleTracksInChunk()

size_t ansys::CffProvider::startReadingVariableOfParticleTracksInChunk ( const VariableName varName)
virtual

Start reading variable in the current chunk.

Parameters
[in]varName- The variable name to read.
Returns
- The dimension of the specified variable.

◆ startReadingZonesOfCategoryWithPhaseVariable() [1/2]

size_t ansys::CffProvider::startReadingZonesOfCategoryWithPhaseVariable ( const ZoneCategory  zoneCategory,
const VariableIdType  varId,
ZoneIds zoneIds 
) const
virtual

Determine the zones in which the phase variable exists, and if valid prepare to read the solution data for the variable in those zones.

To read the solution data for a specific mesh element, element range or zone the following group of functions must be called. In this example the code is reading the solution data for all node zones that contain the requested solution variable name "Pressure":

// Create the provider
ansys::CffProvider* provider = ...;
provider->startReading(ansys::DataClass::CFF_RESULTS);

// Obtain the zones containing ansys::ZoneIds availablity; size_t numComps = provider->startReadingZonesWithPhaseVariable(CFF_NODE_ZONE, "Pressure", availability);

if (numComps && !availability.empty()) { // Determine the size of the expected data from the zone size and // number of components for each element in the zone for (auto n = 0; n != availability.size(); ++n) { ansys::ElemIdType sz = 0; provider->getZoneSizeInfo(availability[n], CFF_ZONE_SIZE, sz);

// Allocate the memory - here we request double precision coordinates
double* data = new double[sz*numComps];
size_t numRead = 
  provider-&gt;getValuesOfPhaseVariableForElementsInZone(availability[n],
                                                      data,
                                                      sz*numComps);

// data will contain X1, Y1, Z1, ..., X2, Y2, Z2 ..., Xn, Yn, Zn, ... // where the number of components will differ by variable }

// Finish reading solution data provider->endReadingZonesWithPhaseVariable();

// Finish reading the resultsdata provider->endReading(ansys::DataClass::CFF_RESULTS);

Solution data can be returned as either single or double precision depending on the functions called.

Parameters
zoneCategory[in] - The category of zone in which to read the variable.
varId[in] - The identifier of the phase variable to read.
zoneIds[out] - The zone identifiers for which the variable exists. May be an empty if the variable isn't available in any zone of the category passed in zoneCategory.
Returns
- 0 if the data isn't available in any zone of the passed zoneCategory or the number of componets that will be required to be allocated per zone element for which solution data may be later requested.

This function must always be called before calling the functions to read the actual variable data.

See also
getValuesOfPhaseVariableForElement, getValuesOfPhaseVariableForElementsInRange, getValuesOfPhaseVariableForElementsInZone, endReadingZonesOfCategoryWithPhaseVariable

◆ startReadingZonesOfCategoryWithPhaseVariable() [2/2]

size_t ansys::CffProvider::startReadingZonesOfCategoryWithPhaseVariable ( const ZoneCategory  zoneCategory,
const VariableName varName,
ZoneIds zoneIds 
) const
virtual

Determine the zones in which the phase variable exists, and if valid prepare to read the solution data for the variable in those zones.

Parameters
zoneCategory[in] - The category of zone in which to read the variable.
varName[in] - The name of the phase variable to read.
zoneIds[out] - The zone identifiers for which the variable exists. May be an empty if the variable isn't available in any zone of the category passed in zoneCategory.
Returns
- 0 if the data isn't available in any zone of the passed zoneCategory or the number of components that will be required to be allocated per zone element for which solution data may be later requested.

This function must always be called before calling the functions to read the actual solutiondata.

See also
getValuesOfPhaseVariableForElement, getValuesOfPhaseVariableForElementsInRange, getValuesOfPhaseVariableForElementsInZone, endReadingZonesOfCategoryWithPhaseVariable

Connect with Ansys