Enumerations
enum	CffReadable { CFF_READABLE_UNKNOWN = -1 , CFF_READABLE_OK , CFF_READABLE_WARN , CFF_READABLE_ERROR }
	An enumerator indicating how well a given file is supported by the API being used. More...

enum	CffDataCacheMode { CFF_HEAVY_DATA_CACHE_MIN = 0 , CFF_NO_HEAVY_DATA_CACHE = 1 , CFF_ALLOW_HEAVY_DATA_CACHE = 2 }
	An enum indicates whether allow CFF API to cache heavy weight data while reading. More...

enum	CffIOMode { CFF_SERIAL_IO = 0 , CFF_PARALLEL_IO }
	An enumeration representing the I/O mode. More...

enum	CffTargetCategory { CFF_TARGET_CATEGORY_UNKNOWN = -1 , CFF_RESTART = 0 , CFF_POST , CFF_PARTITIONED_POST }
	An enumeration that represents the target models available within a CFF database. More...

enum	CffMeshSizeType { CFF_MESHSIZE_MIN = -1 , CFF_MESH_DIMENSION , CFF_MESH_NODE_COUNT , CFF_MESH_EDGE_COUNT , CFF_MESH_FACE_COUNT , CFF_MESH_CELL_COUNT }
	An enumeration that is used with ansys::CffBase::getMeshSize and ansys::CffBase::setMeshSize. More...

enum	CffZoneCategory { CFF_ZONECATEGORY_MIN = -1 , CFF_NODE_ZONE , CFF_EDGE_ZONE , CFF_FACE_ZONE , CFF_CELL_ZONE , CFF_PTCK_ZONE , CFF_OTHR_ZONE }
	An enumeration that is used with ansys::CffBase::getNumZones, ansys::CffBase::getZoneIds, ansys::CffBase::getZoneCategory, ansys::CffBase::setZoneIds and other functions. More...

enum	CffZoneSizeType { CFF_ZONESIZE_MIN = -1 , CFF_ZONE_START_ID , CFF_ZONE_END_ID , CFF_ZONE_SIZE , CFF_ZONE_DIMENSION }
	An enumeration that is used to query or suppply the first and last element ids within a zone, the number of elements (size) and the zones dimension when calling ansys::CffBase::getZoneSizeInfo and ansys::CffBase::setZoneSizeInfo. More...

enum	CffNodeZoneInfoType { CFF_NODEZONEINFO_MIN = -1 , CFF_NODE_ZONE_TYPE }
	An enumerated type that used when querying or setting information that is specific to a node zones using ansys::CffBase::getNodeZoneInfo and ansys::CffBase::setNodeZoneInfo. More...

enum	CffEdgeZoneInfoType { CFF_EDGEZONEINFO_MIN = -1 , CFF_EDGE_ZONE_TYPE , CFF_EDGE_ZONE_EDGE_TYPE }
	An enumerated type that used when querying or setting information that is specific to a edge zones using ansys::CffBase::getEdgeZoneInfo and ansys::CffBase::setEdgeZoneInfo. More...

enum	CffFaceZoneInfoType { CFF_FACEZONEINFO_MIN = -1 , CFF_FACE_ZONE_FACE_TYPE , CFF_FACE_ZONE_CHILD_ZONE_ID , CFF_FACE_ZONE_PARENT0_ZONE_ID , CFF_FACE_ZONE_PARENT1_ZONE_ID , CFF_FACE_ZONE_SHADOW_ZONE_ID , CFF_FACE_ZONE_TYPE , CFF_FACE_ZONE_C0_ZONE_ID , CFF_FACE_ZONE_C1_ZONE_ID }
	An enumerated type that used when querying or setting information that is specific to a face zones using ansys::CffBase::getFaceZoneInfo and ansys::CffBase::setFaceZoneInfo. More...

enum	CffCellZoneInfoType { CFF_CELLZONEINFO_MIN = -1 , CFF_CELL_ZONE_CELL_TYPE , CFF_CELL_ZONE_CHILD_ZONE_ID }
	An enumerated type that used when querying or setting information that is specific to a cell zones using ansys::CffBase::getCellZoneInfo and ansys::CffBase::setCellZoneInfo. More...

enum	CffFaceZonePropType { CFF_FACEZONEPROP_MIN = -1 , CFF_FACE_ZONE_PROP_MAJOR , CFF_FACE_ZONE_PROP_MINOR , CFF_FACE_ZONE_PROP_WALL , CFF_FACE_ZONE_PROP_NCI_OVERLAP , CFF_FACE_ZONE_PROP_PERIODIC , CFF_FACE_ZONE_PROP_INTERNAL , CFF_FACE_ZONE_PROP_NCI_NONOVERLAP }
	An enumerated type that used when querying or setting Fluent properties that are specific to faces zones using ansys::CffBase::getFaceZoneProp and ansys::CffBase::setFaceZoneProp. More...

enum	CffZoneStringInfoType { CFF_ZONESTRINGINFO_MIN = -1 , CFF_ZONE_STRING_NAME , CFF_ZONE_STRING_TYPE }
	An enumerated type that used when querying or setting string properties of zones using ansys::CffBase::getZoneStringInfo and ansys::CffBase::setZoneStringInfo. More...

enum	CffPlainDataType { CFF_DATATYPE_MIN = -1 , CFF_DATATYPE_CHAR , CFF_DATATYPE_UCHAR , CFF_DATATYPE_SHORT , CFF_DATATYPE_INT , CFF_DATATYPE_UINT , CFF_DATATYPE_LONG , CFF_DATATYPE_FLOAT , CFF_DATATYPE_DOUBLE , CFF_DATATYPE_SIZE_T , CFF_DATATYPE_LLONG , CFF_DATATYPE_STR }
	Datatypes available in certain CFF functions. More...

enum	CffDataClass { CFF_DATACLASS_MIN = -1 , CFF_CASE , CFF_RESULTS , CFF_DATA_CLASS_MAX }
	An enumeration that is used within the API to caterorize types of CFF data. More...

enum	CffDataPrecisionType { CFF_DATAPRECISION_MIN = -1 , CFF_PRECISION_DOUBLE , CFF_PRECISION_SINGLE }
	An enumeration that is us used within the CFF API to indicate the precision of floating point data. More...

enum	CffNodeZoneType { CFF_NODE_ZONE_TYPE_MIN = -1 , CFF_NODE_ZONE_INTERIOR = 1 , CFF_NODE_ZONE_BOUNDARY = 2 }
	An enumerated type representing the type of a node zone which may be returned from the function ansys::getNodeZoneInfo or set using ansys::setNodeZoneInfo using the CffNodeZoneInfoType::CFF_NODE_ZONE_TYPE. More...

enum	CffEdgeZoneType { CFF_EDGE_ZONE_TYPE_MIN = -1 , CFF_EDGE_ZONE_INTERIOR = 1 , CFF_EDGE_ZONE_BOUNDARY = 2 }
	An enumerated type representing the type of an edge zone which may be returned from the function ansys::getEdgeZoneInfo or set using ansys::setEdgeZoneInfo using the CffEdgeZoneInfoType::CFF_EDGE_ZONE_TYPE. More...

enum	CffEdgeType { CFF_EDGE_TYPE_MIN = -1 , CFF_EDGE_TYPE_LINEAR = 0 , CFF_EDGE_TYPE_LINEAR3 = 1 , CFF_EDGE_TYPE_N_NODES = 2 }
	An enumerated type representing the type of edges which may be returned from the function ansys::getEdgeZoneInfo or set using ansys::setEdgeZoneInfo using the CffEdgeZoneInfoType::CFF_EDGE_ZONE_EDGE_TYPE. More...

enum	CffFaceZoneType { CFF_FACE_ZONE_TYPE_MIN = -1 , CFF_FACE_ZONE_TYPE_FLUID = 1 , CFF_FACE_ZONE_TYPE_INTERIOR = 2 , CFF_FACE_ZONE_TYPE_RANS_LES_INTERFACE = 2 , CFF_FACE_ZONE_TYPE_WALL = 3 , CFF_FACE_ZONE_TYPE_INTAKE_FAN = 4 , CFF_FACE_ZONE_TYPE_INLET_VENT = 4 , CFF_FACE_ZONE_TYPE_PRESSURE_INLET = 4 , CFF_FACE_ZONE_TYPE_EXHAUST_FAN = 5 , CFF_FACE_ZONE_TYPE_OUTLET_VENT = 5 , CFF_FACE_ZONE_TYPE_PRESSURE_OUTLET = 5 , CFF_FACE_ZONE_TYPE_SYMMETRY = 7 , CFF_FACE_ZONE_TYPE_DEGASSING = 7 , CFF_FACE_ZONE_TYPE_SHADOW = 8 , CFF_FACE_ZONE_TYPE_PRESSURE_FAR_FIELD = 9 , CFF_FACE_ZONE_TYPE_VELOCITY_INLET = 10 , CFF_FACE_ZONE_TYPE_PERIODIC = 12 , CFF_FACE_ZONE_TYPE_FAN = 14 , CFF_FACE_ZONE_TYPE_RADIATOR = 14 , CFF_FACE_ZONE_TYPE_POROUS_JUMP = 14 , CFF_FACE_ZONE_TYPE_MASS_FLOW_INLET = 20 , CFF_FACE_ZONE_TYPE_RECIRCULATION_OUTLET = 20 , CFF_FACE_ZONE_TYPE_RECIRCULATION_INLET = 20 , CFF_FACE_ZONE_TYPE_INTERFACE = 24 , CFF_FACE_ZONE_TYPE_OVERSET = 25 , CFF_FACE_ZONE_TYPE_OUTFLOW = 36 , CFF_FACE_ZONE_TYPE_AXIS = 37 , CFF_FACE_ZONE_TYPE_NETWORK = 51 , CFF_FACE_ZONE_TYPE_NETWORK_END = 52 , CFF_FACE_ZONE_TYPE_SOLID = 61 , CFF_FACE_ZONE_TYPE_USER_DEFINED = 101 }
	An enumerated type representing the boundary type of a face zone which may be returned from the function ansys::getFaceZoneInfo or set using ansys::setFaceZoneInfo using the CffFaceZoneInfoType::CFF_FACE_ZONE_TYPE. More...

enum	CffFaceType { CFF_FACE_TYPE_MIN = -1 , CFF_FACE_TYPE_MIXED = 0 , CFF_FACE_TYPE_LINEAR = 2 , CFF_FACE_TYPE_TRI = 3 , CFF_FACE_TYPE_QUAD = 4 , CFF_FACE_TYPE_POLY = 5 , CFF_FACE_TYPE_TRI6 = 6 }
	An enumerated type representing the type of faces which may be returned from the function ansys::getFaceZoneInfo or set using ansys::setFaceZoneInfo using the CffFaceZoneInfoType::CFF_FACE_ZONE_FACE_TYPE. More...

enum	CffCellType { CFF_CELL_TYPE_MIN = -1 , CFF_CELL_TYPE_MIXED = 0 , CFF_CELL_TYPE_TRI = 1 , CFF_CELL_TYPE_TET = 2 , CFF_CELL_TYPE_QUAD = 3 , CFF_CELL_TYPE_HEX = 4 , CFF_CELL_TYPE_PYRAMID = 5 , CFF_CELL_TYPE_WEDGE = 6 , CFF_CELL_TYPE_POLY = 7 , CFF_CELL_TYPE_GHOST = 8 , CELL_TYPE_TET10 = 9 }
	An enumeration used to represet the type of a Cell element. More...

enum	CffFileFormatType { CFF_Unknown , CFF_HDF , CFF_VTP , CFF_VTU , CFF_CSV , CFF_CFX }
	An enumeration used to represent the type of file that may be determined when querying a files contents using ansys::determineFileFormat or when creating a new ansys::CffFileConsumer object. More...

Detailed Description

Enumeration Type Documentation

◆ CffCellType

enum CffCellType

An enumeration used to represet the type of a Cell element.

Cell elements can be defined with differing number of nodes/faces that define the cell topology.

Common cell types are available and more a more general polyhedral cell type (CFF_CELL_TYPE_POLY) can be used where the topology of the cell doesn't fall into these types. Note Polyhedral cells can only be used in Face/Node style meshes.

Enumerator
CFF_CELL_TYPE_MIN	A value that is may be used to indicate a request is invalid
CFF_CELL_TYPE_MIXED	A value used when a zone contains cells that are of differing types
CFF_CELL_TYPE_TRI	3 nodes, 3 faces
CFF_CELL_TYPE_TET	4 nodes, 4 faces
CFF_CELL_TYPE_QUAD	4 nodes, 4 faces
CFF_CELL_TYPE_HEX	8 nodes, 6 faces
CFF_CELL_TYPE_PYRAMID	5 nodes, 5 faces
CFF_CELL_TYPE_WEDGE	6 nodes, 5 faces
CFF_CELL_TYPE_POLY	Polyhedral cell with a non standard number of faces and nodes
CFF_CELL_TYPE_GHOST	2 nodes, 1 face (only found or used with 2D zones)
CELL_TYPE_TET10	10 nodes, 4 faces - quadratic tetrahedron

◆ CffCellZoneInfoType

enum CffCellZoneInfoType

An enumerated type that used when querying or setting information that is specific to a cell zones using ansys::CffBase::getCellZoneInfo and ansys::CffBase::setCellZoneInfo.

Enumerator

CFF_CELLZONEINFO_MIN

A value that is may be used to indicate a request is invalid

CFF_CELL_ZONE_CELL_TYPE

The element type(s) of all the cells in the zone queried or set

CFF_CELL_ZONE_CHILD_ZONE_ID

The identifier of any child face zone of the zone queried or set

Note: this information will only exist for a zone involved in refinement

◆ CffDataCacheMode

enum CffDataCacheMode

An enum indicates whether allow CFF API to cache heavy weight data while reading.

Caching of heavy weight data can avoid too frequent interacting with disk on the expense of higher memory usage There is a threshold for such heavy weight data caching, which is 50MB in current version. With less frequent accessing of disk, the file reading speed can be faster when

You read data from the same data set for multiple times AND
Each time you read a small amount data (small in the sense that much smaller than the memory cache threshold) By default, the data caching is off in CFF API.

Note

Reading of the same data set for multiple times happens, when

You read data zone by zone, AND
The file is created with CFF API before 2021 R1. Before 2021 R1, data of multiple zones are written into the same data set if element ids are continuous across those zones. After 2021 R1, data of different zones are written into the separate data set even if element ids are continuous across those zones.

The value will be determined based on the version of the file and the version of CFF API.

Enumerator
CFF_HEAVY_DATA_CACHE_MIN	Undefined, it is up to the implementation whether to cache or not, may change from version to version
CFF_NO_HEAVY_DATA_CACHE	Does not allow CFF API to cache heavy weight data
CFF_ALLOW_HEAVY_DATA_CACHE	Allow CFF API to cache heavy weight data

◆ CffDataClass

enum CffDataClass

An enumeration that is used within the API to caterorize types of CFF data.

Enumerator
CFF_DATACLASS_MIN	A value that is may be used to indicate a request is invalid
CFF_CASE	Case: Mesh and Settings
CFF_RESULTS	Results: Solution data (and settings)
CFF_DATA_CLASS_MAX	The number of valid enumerations in DataClass

◆ CffDataPrecisionType

enum CffDataPrecisionType

An enumeration that is us used within the CFF API to indicate the precision of floating point data.

Enumerator
CFF_DATAPRECISION_MIN	A value that is may be used to indicate a request is invalid
CFF_PRECISION_DOUBLE	Double precision
CFF_PRECISION_SINGLE	Single precision

◆ CffEdgeType

enum CffEdgeType

An enumerated type representing the type of edges which may be returned from the function ansys::getEdgeZoneInfo or set using ansys::setEdgeZoneInfo using the CffEdgeZoneInfoType::CFF_EDGE_ZONE_EDGE_TYPE.

Note: a value of 0 returned indicates the node zone is mixed.

Enumerator
CFF_EDGE_TYPE_MIN	A value that is may be used to indicate a request is invalid
CFF_EDGE_TYPE_LINEAR	Two nodes edge
CFF_EDGE_TYPE_LINEAR3	Quadratic edge with 3 nodes
CFF_EDGE_TYPE_N_NODES	Poly edge with multiple nodes

◆ CffEdgeZoneInfoType

enum CffEdgeZoneInfoType

An enumerated type that used when querying or setting information that is specific to a edge zones using ansys::CffBase::getEdgeZoneInfo and ansys::CffBase::setEdgeZoneInfo.

Enumerator
CFF_EDGEZONEINFO_MIN	A value that is may be used to indicate a request is invalid
CFF_EDGE_ZONE_TYPE	Edge zone type
CFF_EDGE_ZONE_EDGE_TYPE	Element type(s) of the edges within the zone

◆ CffEdgeZoneType

enum CffEdgeZoneType

An enumerated type representing the type of an edge zone which may be returned from the function ansys::getEdgeZoneInfo or set using ansys::setEdgeZoneInfo using the CffEdgeZoneInfoType::CFF_EDGE_ZONE_TYPE.

Note: a value of 0 returned indicates the node zone is mixed.

Enumerator
CFF_EDGE_ZONE_TYPE_MIN	A value that is may be used to indicate a request is invalid
CFF_EDGE_ZONE_INTERIOR	Interior edge zone
CFF_EDGE_ZONE_BOUNDARY	Boundary edge zone

◆ CffFaceType

enum CffFaceType

An enumerated type representing the type of faces which may be returned from the function ansys::getFaceZoneInfo or set using ansys::setFaceZoneInfo using the CffFaceZoneInfoType::CFF_FACE_ZONE_FACE_TYPE.

Enumerator
CFF_FACE_TYPE_MIN	A value that is may be used to indicate a request is invalid
CFF_FACE_TYPE_MIXED	Mixed
CFF_FACE_TYPE_LINEAR	2 nodes, 0 edges
CFF_FACE_TYPE_TRI	3 nodes, 3 edges
CFF_FACE_TYPE_QUAD	4 nodes, 4 edges
CFF_FACE_TYPE_POLY	arbitrary number of nodes/edges
CFF_FACE_TYPE_TRI6	Quadratic Triangle with 3 mid nodes

◆ CffFaceZoneInfoType

enum CffFaceZoneInfoType

An enumerated type that used when querying or setting information that is specific to a face zones using ansys::CffBase::getFaceZoneInfo and ansys::CffBase::setFaceZoneInfo.

Enumerator
CFF_FACEZONEINFO_MIN	A value that is may be used to indicate a request is invalid
CFF_FACE_ZONE_FACE_TYPE	The Element type(s) of the faces within the zone being queried or set
CFF_FACE_ZONE_CHILD_ZONE_ID	The identifier of any child face zone of the zone queried or set Note this information will only exist for a zone involved in refinement
CFF_FACE_ZONE_PARENT0_ZONE_ID	In the case where the zone being queried or set is part of a non conformal interface the zone identifier will represent the side 0 parent in that interface
CFF_FACE_ZONE_PARENT1_ZONE_ID	In the case where the zone being queried or set is part of a non conformal interface the zone identifier will represent the side 1 parent in that interface
CFF_FACE_ZONE_SHADOW_ZONE_ID	The identifier of any shadow zone associated with the zone queried or set. Note Typically this only exists for zones with type CFF_ZONE_TYPE_SHADOW or CFF_ZONE_TYPE_PERIODIC etc
CFF_FACE_ZONE_TYPE	The physics type that represents the boundary condition applied to the zone being queried or set. The boundary condition types are specified in the typedef CffFaceZoneType Note If a physics model is supplied or constructed this information may not exist
CFF_FACE_ZONE_C0_ZONE_ID	The identifier of any parent zone on side 0 of the zone queried or set Note If a topology model is supplied or constructed this information may not exist
CFF_FACE_ZONE_C1_ZONE_ID	The identifier of any parent zone on side 1 of the zone queried or set Note If a topology model is supplied or constructed this information may not exist

◆ CffFaceZonePropType

enum CffFaceZonePropType

An enumerated type that used when querying or setting Fluent properties that are specific to faces zones using ansys::CffBase::getFaceZoneProp and ansys::CffBase::setFaceZoneProp.

Note: ANSYS Fluent only information

The face zone properties were added for backward compatible with old version of ANSYS Fluent, not needed for general purpose mesh.

Note: For versions of Fluent prior to 2021 R1 files without this information could not always be read successfully into ANSYS Fluent. For versions of Fluent after 2021 R1, zones without such info can be successfully read by fluent

Enumerator
CFF_FACEZONEPROP_MIN
CFF_FACE_ZONE_PROP_MAJOR
CFF_FACE_ZONE_PROP_MINOR
CFF_FACE_ZONE_PROP_WALL
CFF_FACE_ZONE_PROP_NCI_OVERLAP
CFF_FACE_ZONE_PROP_PERIODIC
CFF_FACE_ZONE_PROP_INTERNAL
CFF_FACE_ZONE_PROP_NCI_NONOVERLAP

◆ CffFaceZoneType

enum CffFaceZoneType

An enumerated type representing the boundary type of a face zone which may be returned from the function ansys::getFaceZoneInfo or set using ansys::setFaceZoneInfo using the CffFaceZoneInfoType::CFF_FACE_ZONE_TYPE.

Note: These values are consistent with Fluent but other solvers may not supply them if they supply a physics model with in the CFF model.

Enumerator
CFF_FACE_ZONE_TYPE_MIN	A value that is may be used to indicate a request is invalid
CFF_FACE_ZONE_TYPE_FLUID	Fluid zone
CFF_FACE_ZONE_TYPE_INTERIOR	Faces interior to a cell zone or multiple cell zones
CFF_FACE_ZONE_TYPE_RANS_LES_INTERFACE	Interface boundary - RANS LES
CFF_FACE_ZONE_TYPE_WALL	Wall boundary
CFF_FACE_ZONE_TYPE_INTAKE_FAN	Inlet boundary - Fan
CFF_FACE_ZONE_TYPE_INLET_VENT	Inlet boundary - Vent
CFF_FACE_ZONE_TYPE_PRESSURE_INLET	Inlet boundary - Pressure
CFF_FACE_ZONE_TYPE_EXHAUST_FAN	Outlet boundary boundary - Exhaust fan
CFF_FACE_ZONE_TYPE_OUTLET_VENT	Outlet boundary - Vent
CFF_FACE_ZONE_TYPE_PRESSURE_OUTLET	Outlet boundary
CFF_FACE_ZONE_TYPE_SYMMETRY	Symmetry boundary - Pressure
CFF_FACE_ZONE_TYPE_DEGASSING	Degassing boundary
CFF_FACE_ZONE_TYPE_SHADOW	Shadow boundary
CFF_FACE_ZONE_TYPE_PRESSURE_FAR_FIELD	Far field pressure boundary
CFF_FACE_ZONE_TYPE_VELOCITY_INLET	Inlet boundary - Velocity
CFF_FACE_ZONE_TYPE_PERIODIC	Periodic boundary
CFF_FACE_ZONE_TYPE_FAN	Fan boundary
CFF_FACE_ZONE_TYPE_RADIATOR	Radiator boundary
CFF_FACE_ZONE_TYPE_POROUS_JUMP	Porous Jump boundary
CFF_FACE_ZONE_TYPE_MASS_FLOW_INLET	Inlet boundary - Mass Flow
CFF_FACE_ZONE_TYPE_RECIRCULATION_OUTLET	Outlet boundary - Recirculation
CFF_FACE_ZONE_TYPE_RECIRCULATION_INLET	Inlet boundary - Recirculation
CFF_FACE_ZONE_TYPE_INTERFACE	Interface boundary
CFF_FACE_ZONE_TYPE_OVERSET	Overset boundary
CFF_FACE_ZONE_TYPE_OUTFLOW	Outlet boundary - Outflow
CFF_FACE_ZONE_TYPE_AXIS	Axis boundary
CFF_FACE_ZONE_TYPE_NETWORK	Network boundary
CFF_FACE_ZONE_TYPE_NETWORK_END	Network End boundary
CFF_FACE_ZONE_TYPE_SOLID	Solid zone
CFF_FACE_ZONE_TYPE_USER_DEFINED	User defined boundary

◆ CffFileFormatType

enum CffFileFormatType

An enumeration used to represent the type of file that may be determined when querying a files contents using ansys::determineFileFormat or when creating a new ansys::CffFileConsumer object.

Note: Currently only CFF_HDF should be used.

Enumerator
CFF_Unknown	Unknown file type, returned when the file format cannot be determined
CFF_HDF	Returned when a file is determined to be in HDF5 format or when creating a new instance of the ansys::CffFileConsumer
CFF_VTP	Returned when a file is determined to be in VTP XML format
CFF_VTU	Returned when a file is determined to be in VTU XML format
CFF_CSV	Unsupported file type: CSV (comma seperated values)
CFF_CFX	Unsupported file type: value returned when a CFX def/res file is detected

◆ CffIOMode

enum CffIOMode

An enumeration representing the I/O mode.

The I/O mode, can be serial or parallel

Note: Writing a CFF model is supported in serial and parallel.; Reading in parallel is not supported in CFF API, setting the I/O mode while using a CffProvider objects will have no affect on the I/O behavior or the performance of the I/O operations

Enumerator
CFF_SERIAL_IO	Serial I/O (Supported in CffProvider and CffConsumer)
CFF_PARALLEL_IO	Parallel I/O (Currenltly only supported in CffConsumer)

◆ CffMeshSizeType

enum CffMeshSizeType

An enumeration that is used with ansys::CffBase::getMeshSize and ansys::CffBase::setMeshSize.

Enumerator
CFF_MESHSIZE_MIN	A value that is may be used to indicate a request is invalid
CFF_MESH_DIMENSION	The overall dimension of the mesh
CFF_MESH_NODE_COUNT	The total number of nodes the mesh contains
CFF_MESH_EDGE_COUNT	The total number of edges the mesh contains
CFF_MESH_FACE_COUNT	The total number of faces the mesh contains
CFF_MESH_CELL_COUNT	The total number of cells the mesh contains

◆ CffNodeZoneInfoType

enum CffNodeZoneInfoType

An enumerated type that used when querying or setting information that is specific to a node zones using ansys::CffBase::getNodeZoneInfo and ansys::CffBase::setNodeZoneInfo.

Enumerator
CFF_NODEZONEINFO_MIN	A value that is may be used to indicate a request is invalid
CFF_NODE_ZONE_TYPE	Node zone type

◆ CffNodeZoneType

enum CffNodeZoneType

An enumerated type representing the type of a node zone which may be returned from the function ansys::getNodeZoneInfo or set using ansys::setNodeZoneInfo using the CffNodeZoneInfoType::CFF_NODE_ZONE_TYPE.

Note: a value of 0 returned indicates the node zone is mixed.

Enumerator
CFF_NODE_ZONE_TYPE_MIN	A value that is may be used to indicate a request is invalid
CFF_NODE_ZONE_INTERIOR	Interior node zone
CFF_NODE_ZONE_BOUNDARY	Boundary node zone

◆ CffPlainDataType

enum CffPlainDataType

Datatypes available in certain CFF functions.

Enumerator
CFF_DATATYPE_MIN	A value that is may be used to indicate a request is invalid
CFF_DATATYPE_CHAR	char
CFF_DATATYPE_UCHAR	unsigned char
CFF_DATATYPE_SHORT	short
CFF_DATATYPE_INT	int
CFF_DATATYPE_UINT	unsigned int
CFF_DATATYPE_LONG	long
CFF_DATATYPE_FLOAT	float
CFF_DATATYPE_DOUBLE	double
CFF_DATATYPE_SIZE_T	size_t
CFF_DATATYPE_LLONG	long long
CFF_DATATYPE_STR	string

◆ CffReadable

enum CffReadable

An enumerator indicating how well a given file is supported by the API being used.

The value will be determined based on the version of the file and the version of CFF API.

Enumerator
CFF_READABLE_UNKNOWN	The readability is unknown
CFF_READABLE_OK	The CFF API can read the file
CFF_READABLE_WARN	The CFF API may be able to read the file
CFF_READABLE_ERROR	The CFF API cannot read the file

◆ CffTargetCategory

enum CffTargetCategory

An enumeration that represents the target models available within a CFF database.

The CFF API allows data to be written to different models that may be used for different purposes. Typically a file contains only one model of the data but query functions are provided to determine what target models are avabilable.

Those target categories are: CFF Restart, CFF Post and CFF Partitioned Post.

Note: CFF Partitioned Post is currently unsupported.

Enumerator
CFF_TARGET_CATEGORY_UNKNOWN	Undefined
CFF_RESTART	CFF Restart model. CFF Restart is mainly for the purpose of restart. Data within a model of this type of CFF model should enable the solver that wrote the file to smoothly restart from the data the model contains. The mesh within this type of model is supplied connected so for some post processing situations such as extracting a boundary surface the volume mesh may also need to be read and vice versa. This is especially true with a Face/Node style mesh is written as The Cell topologies ina Cell Zone are defined by reading the appropriate face zones that define them. See Ansys Common Fluids Mesh Data Model documentation for further details. Solution data may be written at nodal coordinates, face centers and/or cell centers. Note When ANSYS Fluent writes data in this model the solution data may not be easily post processed by downstream components as some solution variables may require modification and/or correction in order to obtain the accurate results. When ANSYS CFX writes data in this model is the solution data may be read without need for further manipulation. When data is written to this type of model by other solvers it is recommended you should reference the specific solver documentation When using post procecssors such as ANSYS Ensight it is preferred that a user of ANSYS Fluent should write data to a CFF Post model as data requires no further manipulation and the mesh is quicker to process.
CFF_POST	CFF Post model. The CFF Post model is mainly for the purpose of post processing. In contrast to the CFF Restart model the mesh is written in a way that each zone does not share any nodes with any other zone inn the model. This means that the zones are effectively disconnected and independent. Providing the mesh in this form allows a reader of the data to more quickly access the mesh. Solution data must be accurate and ready for post processing without further additional manipulation. Solution data should in most instances be supplied at nodal coordinates except where the data is has a special purpose such as a variable that might be, for example, named Cell Partition, this would need to be supplied at the cell center in order for it to be associated with a cell. Note Currently only ANSYS Fluent can write the CFF Post model When processing in ANSYS Ensight, CFF-Post is known to be more efficient than CFF Restart both in terms of mesh read and solution display.
CFF_PARTITIONED_POST	Partitioned Post model. Conceptual model for faster post processing Not fully supported by the CFF API or any ANSYS solver.

◆ CffZoneCategory

enum CffZoneCategory

An enumeration that is used with ansys::CffBase::getNumZones, ansys::CffBase::getZoneIds, ansys::CffBase::getZoneCategory, ansys::CffBase::setZoneIds and other functions.

Mesh elements are grouped into zones. A zone only hold certain category of mesh element

Enumerator
CFF_ZONECATEGORY_MIN	A value that is may be used to indicate a request is invalid
CFF_NODE_ZONE	Zone contains nodes
CFF_EDGE_ZONE	Zone contains edges
CFF_FACE_ZONE	Zone contains faces
CFF_CELL_ZONE	Zone contains cells
CFF_PTCK_ZONE	Zone contains particles
CFF_OTHR_ZONE	Zone contains other other element types

◆ CffZoneSizeType

enum CffZoneSizeType

An enumeration that is used to query or suppply the first and last element ids within a zone, the number of elements (size) and the zones dimension when calling ansys::CffBase::getZoneSizeInfo and ansys::CffBase::setZoneSizeInfo.

Mesh elements are grouped into zones. The elements are expected to be contiguous.

◆ CffZoneStringInfoType

enum CffZoneStringInfoType

An enumerated type that used when querying or setting string properties of zones using ansys::CffBase::getZoneStringInfo and ansys::CffBase::setZoneStringInfo.