Skip to main content

Common Fluids Format 2025 R1

Typedefs

Last update: 19.05.2025

Typedefs

typedef int CffMeshIdType
 Type of a variable used to represent the identifier of a mesh. More...
 
typedef int CffPartitionIdType
 Type of a variable used to represent the identifier of a partition. More...
 
typedef int CffVersionType
 Type of a variable representing the version number of the API or file. More...
 
typedef short CffNodeCountType
 Type used when representing the number of nodes of an element. More...
 
typedef CffNodeCountType CffCountType
 Type used when the number of entries per object within a set. More...
 
typedef size_t CffElemIdType
 Type used when representing the identifier of an element or the size of a zone. More...
 
typedef size_t CffSectionIdType
 Type used when representing a section. More...
 
typedef int CffTimeLevelType
 Type representing a time level. More...
 
typedef char * CffCategoryName
 Type used to represent a category name ('C' API only) More...
 
typedef CffCategoryNameCffCategoryNames
 Type representing a pointer to multiple category names ('C' API only) More...
 
typedef int CffZoneIdType
 Type used to represent the identifier of a zone. More...
 
typedef CffZoneIdTypeCffZoneIds
 Type used to represent pointer to multiple zone ids ('C' API only) More...
 
typedef short CffPhaseIdType
 Type used to represent the identifier of a phase. More...
 
typedef CffPhaseIdTypeCffPhaseIds
 Type used to represent pointer to multiple phase ids ('C' API only) More...
 
typedef char * CffPhaseName
 Type used to represent the name of a phase ('C' API only) More...
 
typedef CffPhaseNameCffPhaseNames
 Type used to represent pointer to multiple phase names ('C' API only) More...
 
typedef char * CffInjectionName
 Type used to represent the name of a particle injection ('C' API only) More...
 
typedef CffInjectionNameCffInjectionNames
 Type used to represent pointer to multiple particle injection names ('C' API only) More...
 
typedef int CffVariableIdType
 Type used to represent the identifier of a variable ('C' API only) More...
 
typedef CffVariableIdTypeCffVariableIds
 Type used to represent pointer to multiple variable identifiers ('C' API only) More...
 
typedef char * CffVariableName
 Type used to represent the name of a variable ('C' API only) More...
 
typedef CffVariableNameCffVariableNames
 Type used to represent pointer to multiple variable names ('C' API only) More...
 
typedef char * CffGroupName
 Type used to represent the name of a particle group ('C' API only) More...
 
typedef CffGroupNameCffGroupNames
 Type used to represent pointer to multiple particle group names ('C' API only) More...
 
typedef CffPlainDataTypeCffPlainDataTypes
 Type used to represent multiple plain data types ('C' API only) More...
 
typedef char * CffSolverType
 Type used to represent the solver name ('C' API only) More...
 
typedef short CffVariableDimensionType
 Typename used to represent the dimension of a variable. More...
 
typedef char * CffQuantityType
 Type used to represent the quantity type ('C' API only) More...
 
typedef char * CffAttributeName
 Type used to represent the variable attribute name ('C' API only) More...
 
typedef char * CffAttributeValue
 Type used to represent the variable attribute value ('C' API only) More...
 
typedef CffMeshIdType ansys::MeshIdType
 Alias for CffMeshIdType ('C++' API only) More...
 
typedef CffPartitionIdType ansys::PartitionIdType
 Alias for CffPartitionIdType ('C++' API only) More...
 
typedef CffVersionType ansys::VersionType
 Alias for CffVersionType ('C++' API only) More...
 
typedef CffNodeCountType ansys::NodeCountType
 alais for CffNodeCountType ('C++' API only) More...
 
typedef CffCountType ansys::CountType
 Alias for CffCountType ('C++' API only) More...
 
typedef CffElemIdType ansys::ElemIdType
 Alias for CffElemIdType ('C++' API only) More...
 
typedef CffSectionIdType ansys::SectionIdType
 Alias for CffSectionIdType ('C++' API only) More...
 
typedef CffIOMode ansys::IOMode
 Alias for CffIOMode ('C++' API only) More...
 
typedef CffDataCacheMode ansys::DataCacheMode
 Alias for CffDataCacheMode ('C++' API only) More...
 
typedef CffTargetCategory ansys::TargetCategory
 Alias for CffTargetCategory ('C++' API only) More...
 
typedef CffVariableDimensionType ansys::VariableDimensionType
 Alias for CffVariableDimensionType ('C++' API only) More...
 
typedef std::string ansys::QuantityType
 Type used to represent a quantity type ('C++' API only) More...
 
typedef std::string ansys::AttributeName
 Type used to represent the variable attribute name ('C++' API only) More...
 
typedef std::vector< AttributeNameansys::AttributeNames
 Type used to represent a number of variable attribute names ('C++' API only) More...
 
typedef std::string ansys::AttributeValue
 Type used to represent the variable attribute value ('C++' API only) More...
 
typedef CffTimeLevelType ansys::TimeLevelType
 Alias for CffTimeLevelType ('C++' API only) More...
 
typedef std::vector< TimeLevelTypeansys::TimeLevels
 Type used to represent a number of time levels ('C++' API only) More...
 
typedef std::vector< MeshIdTypeansys::MeshIds
 Type used to represent a number of mesh identifiers ('C++' API only) More...
 
typedef std::vector< PartitionIdTypeansys::PartitionIds
 Type used to represent a number of partition identifiers ('C++' API only) More...
 
typedef std::vector< TargetCategoryansys::TargetCategories
 Type used to represent a number of target categories ('C++' API only) More...
 
typedef std::string ansys::CategoryName
 Type used to represent a category name ('C++' API only) More...
 
typedef std::vector< CategoryNameansys::CategoryNames
 Type used to represent a number of category names ('C++' API only) More...
 
typedef CffZoneIdType ansys::ZoneIdType
 Alias for CffZoneIdType ('C++' API only) More...
 
typedef std::vector< ZoneIdTypeansys::ZoneIds
 Type used to represent a number of zone identifiers('C++' API only) More...
 
typedef CffPhaseIdType ansys::PhaseIdType
 Alias for CffPhaseIdType ('C++' API only) More...
 
typedef std::vector< PhaseIdTypeansys::PhaseIds
 Type used to represent a number of phase identifiers ids('C++' API only) More...
 
typedef std::string ansys::PhaseName
 Type used to represent a name of a phase ('C++' API only) More...
 
typedef std::vector< PhaseNameansys::PhaseNames
 Type used to represent a number of phase names ('C++' API only) More...
 
typedef std::string ansys::InjectionName
 Type used to represent a particle injection name ('C++' API only) More...
 
typedef std::vector< InjectionNameansys::InjectionNames
 Type used to represent a number of particle injection names ('C++' API only) More...
 
typedef CffVariableIdType ansys::VariableIdType
 Type used to represent the identifier of a variable ('C++' API only) More...
 
typedef std::vector< VariableIdTypeansys::VariableIds
 Type used to represent a number of variable identifiers ('C++' API only) More...
 
typedef std::string ansys::VariableName
 Type used to represent the name of a variable ('C++' API only) More...
 
typedef std::vector< VariableNameansys::VariableNames
 Type used to represent a number of variable names ('C++' API only) More...
 
typedef std::string ansys::GroupName
 Type used to represent the name of a particle group('C++' API only) More...
 
typedef std::vector< GroupNameansys::GroupNames
 Type used to represent a number of particle groups ('C++' API only) More...
 
typedef std::string ansys::SolverType
 Type used to represent the solver type ('C++' API only) More...
 
typedef std::string ansys::VariableTarget
 Type used to represent the variable target ('C++' API only) More...
 
typedef CffMeshSizeType ansys::MeshSizeType
 Alias for CffMeshSizeType ('C++' API only) More...
 
typedef CffZoneCategory ansys::ZoneCategory
 Alias for CffZoneCategory ('C++' API only) More...
 
typedef CffZoneSizeType ansys::ZoneSizeType
 Alias for CffZoneSizeType ('C++' API only) More...
 
typedef CffNodeZoneInfoType ansys::NodeZoneInfoType
 Alias for CffNodeZoneInfoType ('C++' API only) More...
 
typedef CffEdgeZoneInfoType ansys::EdgeZoneInfoType
 Alias for CffEdgeZoneInfoType ('C++' API only) More...
 
typedef CffFaceZoneInfoType ansys::FaceZoneInfoType
 Alias for CffFaceZoneInfoType ('C++' API only) More...
 
typedef CffCellZoneInfoType ansys::CellZoneInfoType
 Alias for CffCellZoneInfoType ('C++' API only) More...
 
typedef CffFaceZonePropType ansys::FaceZonePropType
 Alias for CffFaceZonePropType ('C++' API only) More...
 
typedef CffZoneStringInfoType ansys::ZoneStringInfoType
 Alias for CffZoneStringInfoType ('C++' API only) More...
 
typedef CffPlainDataType ansys::PlainDataType
 Alias for CffPlainDataType ('C++' API only) More...
 
typedef CffDataClass ansys::DataClass
 Alias for CffDataClass ('C++' API only) More...
 
typedef CffDataPrecisionType ansys::DataPrecisionType
 Alias for CffDataPrecisionType ('C++' API only) More...
 
typedef CffNodeZoneType ansys::NodeZoneType
 Alias for CffNodeZoneType ('C++' API only) More...
 
typedef CffEdgeZoneType ansys::EdgeZoneType
 Alias for CffEdgeZoneType ('C++' API only) More...
 
typedef CffFaceZoneType ansys::FaceZoneType
 Alias for CffFaceZoneType ('C++' API only) More...
 
typedef CffEdgeType ansys::EdgeType
 Alias for CffEdgeType ('C++' API only) More...
 
typedef CffFaceType ansys::FaceType
 Alias for CffFaceType ('C++' API only) More...
 
typedef CffCellType ansys::CellType
 Alias for CffCellType ('C++' API only) More...
 
typedef CffFileFormatType ansys::FileFormatType
 Alias for CffFileFormatType ('C++' API only) More...
 

Detailed Description

Typedef Documentation

◆ AttributeName

typedef std::string ansys::AttributeName

Type used to represent the variable attribute name ('C++' API only)

◆ AttributeNames

typedef std::vector<AttributeName> ansys::AttributeNames

Type used to represent a number of variable attribute names ('C++' API only)

◆ AttributeValue

typedef std::string ansys::AttributeValue

Type used to represent the variable attribute value ('C++' API only)

◆ CategoryName

typedef std::string ansys::CategoryName

Type used to represent a category name ('C++' API only)

◆ CategoryNames

typedef std::vector<CategoryName> ansys::CategoryNames

Type used to represent a number of category names ('C++' API only)

◆ CellType

Alias for CffCellType ('C++' API only)

◆ CellZoneInfoType

◆ CffAttributeName

typedef char* CffAttributeName

Type used to represent the variable attribute name ('C' API only)

◆ CffAttributeValue

typedef char* CffAttributeValue

Type used to represent the variable attribute value ('C' API only)

◆ CffCategoryName

typedef char* CffCategoryName

Type used to represent a category name ('C' API only)

◆ CffCategoryNames

Type representing a pointer to multiple category names ('C' API only)

◆ CffCountType

Type used when the number of entries per object within a set.

◆ CffElemIdType

typedef size_t CffElemIdType

Type used when representing the identifier of an element or the size of a zone.

◆ CffGroupName

typedef char* CffGroupName

Type used to represent the name of a particle group ('C' API only)

◆ CffGroupNames

Type used to represent pointer to multiple particle group names ('C' API only)

◆ CffInjectionName

typedef char* CffInjectionName

Type used to represent the name of a particle injection ('C' API only)

◆ CffInjectionNames

Type used to represent pointer to multiple particle injection names ('C' API only)

◆ CffMeshIdType

typedef int CffMeshIdType

Type of a variable used to represent the identifier of a mesh.

See functions ansys::CffBase::CffBase::getMeshId and ansys::CffBase::setMeshId and ansys::CffProvider::hasMeshId, ansys::CffProvider::availableMeshIds

◆ CffNodeCountType

typedef short CffNodeCountType

Type used when representing the number of nodes of an element.

◆ CffPartitionIdType

typedef int CffPartitionIdType

Type of a variable used to represent the identifier of a partition.

See functions ansys::CffBase::CffBase::getPartitionId, ansys::CffBase::setPartitionId and ansys::CffProvider::hasPartition, and ansys::CffPartitionIds

◆ CffPhaseIds

Type used to represent pointer to multiple phase ids ('C' API only)

◆ CffPhaseIdType

typedef short CffPhaseIdType

Type used to represent the identifier of a phase.

◆ CffPhaseName

typedef char* CffPhaseName

Type used to represent the name of a phase ('C' API only)

◆ CffPhaseNames

Type used to represent pointer to multiple phase names ('C' API only)

◆ CffPlainDataTypes

Type used to represent multiple plain data types ('C' API only)

◆ CffQuantityType

typedef char* CffQuantityType

Type used to represent the quantity type ('C' API only)

◆ CffSectionIdType

typedef size_t CffSectionIdType

Type used when representing a section.

◆ CffSolverType

typedef char* CffSolverType

Type used to represent the solver name ('C' API only)

◆ CffTimeLevelType

typedef int CffTimeLevelType

Type representing a time level.

Time levels are solver concepts which should be used with care to write variables to allow smooth restart where variables at different coeffiicient loops are required to be written.

◆ CffVariableDimensionType

typedef short CffVariableDimensionType

Typename used to represent the dimension of a variable.

◆ CffVariableIds

Type used to represent pointer to multiple variable identifiers ('C' API only)

◆ CffVariableIdType

typedef int CffVariableIdType

Type used to represent the identifier of a variable ('C' API only)

◆ CffVariableName

typedef char* CffVariableName

Type used to represent the name of a variable ('C' API only)

◆ CffVariableNames

Type used to represent pointer to multiple variable names ('C' API only)

◆ CffVersionType

typedef int CffVersionType

Type of a variable representing the version number of the API or file.

◆ CffZoneIds

Type used to represent pointer to multiple zone ids ('C' API only)

◆ CffZoneIdType

typedef int CffZoneIdType

Type used to represent the identifier of a zone.

◆ CountType

Alias for CffCountType ('C++' API only)

◆ DataCacheMode

Alias for CffDataCacheMode ('C++' API only)

◆ DataClass

Alias for CffDataClass ('C++' API only)

◆ DataPrecisionType

◆ EdgeType

Alias for CffEdgeType ('C++' API only)

◆ EdgeZoneInfoType

◆ EdgeZoneType

Alias for CffEdgeZoneType ('C++' API only)

◆ ElemIdType

Alias for CffElemIdType ('C++' API only)

◆ FaceType

Alias for CffFaceType ('C++' API only)

◆ FaceZoneInfoType

◆ FaceZonePropType

◆ FaceZoneType

Alias for CffFaceZoneType ('C++' API only)

◆ FileFormatType

Alias for CffFileFormatType ('C++' API only)

◆ GroupName

typedef std::string ansys::GroupName

Type used to represent the name of a particle group('C++' API only)

◆ GroupNames

typedef std::vector<GroupName> ansys::GroupNames

Type used to represent a number of particle groups ('C++' API only)

◆ InjectionName

typedef std::string ansys::InjectionName

Type used to represent a particle injection name ('C++' API only)

◆ InjectionNames

typedef std::vector<InjectionName> ansys::InjectionNames

Type used to represent a number of particle injection names ('C++' API only)

◆ IOMode

Alias for CffIOMode ('C++' API only)

◆ MeshIds

typedef std::vector<MeshIdType> ansys::MeshIds

Type used to represent a number of mesh identifiers ('C++' API only)

◆ MeshIdType

Alias for CffMeshIdType ('C++' API only)

◆ MeshSizeType

Alias for CffMeshSizeType ('C++' API only)

◆ NodeCountType

alais for CffNodeCountType ('C++' API only)

◆ NodeZoneInfoType

◆ NodeZoneType

Alias for CffNodeZoneType ('C++' API only)

◆ PartitionIds

typedef std::vector<PartitionIdType> ansys::PartitionIds

Type used to represent a number of partition identifiers ('C++' API only)

◆ PartitionIdType

Alias for CffPartitionIdType ('C++' API only)

◆ PhaseIds

typedef std::vector<PhaseIdType> ansys::PhaseIds

Type used to represent a number of phase identifiers ids('C++' API only)

◆ PhaseIdType

Alias for CffPhaseIdType ('C++' API only)

◆ PhaseName

typedef std::string ansys::PhaseName

Type used to represent a name of a phase ('C++' API only)

◆ PhaseNames

typedef std::vector<PhaseName> ansys::PhaseNames

Type used to represent a number of phase names ('C++' API only)

◆ PlainDataType

Alias for CffPlainDataType ('C++' API only)

◆ QuantityType

typedef std::string ansys::QuantityType

Type used to represent a quantity type ('C++' API only)

◆ SectionIdType

Alias for CffSectionIdType ('C++' API only)

◆ SolverType

typedef std::string ansys::SolverType

Type used to represent the solver type ('C++' API only)

◆ TargetCategories

Type used to represent a number of target categories ('C++' API only)

◆ TargetCategory

Alias for CffTargetCategory ('C++' API only)

◆ TimeLevels

typedef std::vector<TimeLevelType> ansys::TimeLevels

Type used to represent a number of time levels ('C++' API only)

◆ TimeLevelType

Alias for CffTimeLevelType ('C++' API only)

◆ VariableDimensionType

◆ VariableIds

typedef std::vector<VariableIdType> ansys::VariableIds

Type used to represent a number of variable identifiers ('C++' API only)

◆ VariableIdType

Type used to represent the identifier of a variable ('C++' API only)

◆ VariableName

typedef std::string ansys::VariableName

Type used to represent the name of a variable ('C++' API only)

◆ VariableNames

typedef std::vector<VariableName> ansys::VariableNames

Type used to represent a number of variable names ('C++' API only)

◆ VariableTarget

typedef std::string ansys::VariableTarget

Type used to represent the variable target ('C++' API only)

◆ VersionType

Alias for CffVersionType ('C++' API only)

◆ ZoneCategory

Alias for CffZoneCategory ('C++' API only)

◆ ZoneIds

typedef std::vector<ZoneIdType> ansys::ZoneIds

Type used to represent a number of zone identifiers('C++' API only)

◆ ZoneIdType

Alias for CffZoneIdType ('C++' API only)

◆ ZoneSizeType

Alias for CffZoneSizeType ('C++' API only)

◆ ZoneStringInfoType

Connect with Ansys