Classes
class	CffBase
	Base class that provides common function used by both CffConsumer and CffProvider classes. More...

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

class	CffDataTypeTrait

class	CffFileConsumer
	Class that provides functions to access data stored within a CFF file. More...

class	CffFileIO
	Base class that provides common function used in File providers such as ansys::CffFileProvider. More...

class	CffFileProvider
	Class that provides functions to access data stored within a CFF file. More...

class	CffLocationModel
	A Topology model providing user visible topological names. More...

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

class	CffVersion
	Provides some basic version extraction and comparison functions. More...

struct	LocationModelData

Typedefs
typedef CffMeshIdType	MeshIdType
	Alias for CffMeshIdType ('C++' API only)

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

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

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

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

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

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

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

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

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

typedef CffVariableDimensionType	VariableDimensionType
	Alias for CffVariableDimensionType ('C++' API only)

typedef std::string	QuantityType
	Type used to represent a quantity type ('C++' API only)

typedef std::string	AttributeName
	Type used to represent the variable attribute name ('C++' API only)

typedef std::vector< AttributeName >	AttributeNames
	Type used to represent a number of variable attribute names ('C++' API only)

typedef std::string	AttributeValue
	Type used to represent the variable attribute value ('C++' API only)

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

typedef std::vector< TimeLevelType >	TimeLevels
	Type used to represent a number of time levels ('C++' API only)

typedef std::vector< MeshIdType >	MeshIds
	Type used to represent a number of mesh identifiers ('C++' API only)

typedef std::vector< PartitionIdType >	PartitionIds
	Type used to represent a number of partition identifiers ('C++' API only)

typedef std::vector< TargetCategory >	TargetCategories
	Type used to represent a number of target categories ('C++' API only)

typedef std::string	CategoryName
	Type used to represent a category name ('C++' API only)

typedef std::vector< CategoryName >	CategoryNames
	Type used to represent a number of category names ('C++' API only)

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

typedef std::vector< ZoneIdType >	ZoneIds
	Type used to represent a number of zone identifiers('C++' API only)

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

typedef std::vector< PhaseIdType >	PhaseIds
	Type used to represent a number of phase identifiers ids('C++' API only)

typedef std::string	PhaseName
	Type used to represent a name of a phase ('C++' API only)

typedef std::vector< PhaseName >	PhaseNames
	Type used to represent a number of phase names ('C++' API only)

typedef std::string	InjectionName
	Type used to represent a particle injection name ('C++' API only)

typedef std::vector< InjectionName >	InjectionNames
	Type used to represent a number of particle injection names ('C++' API only)

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

typedef std::vector< VariableIdType >	VariableIds
	Type used to represent a number of variable identifiers ('C++' API only)

typedef std::string	VariableName
	Type used to represent the name of a variable ('C++' API only)

typedef std::vector< VariableName >	VariableNames
	Type used to represent a number of variable names ('C++' API only)

typedef std::string	GroupName
	Type used to represent the name of a particle group('C++' API only)

typedef std::vector< GroupName >	GroupNames
	Type used to represent a number of particle groups ('C++' API only)

typedef std::string	SolverType
	Type used to represent the solver type ('C++' API only)

typedef std::string	VariableTarget
	Type used to represent the variable target ('C++' API only)

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

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

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

typedef CffNodeZoneInfoType	NodeZoneInfoType
	Alias for CffNodeZoneInfoType ('C++' API only)

typedef CffEdgeZoneInfoType	EdgeZoneInfoType
	Alias for CffEdgeZoneInfoType ('C++' API only)

typedef CffFaceZoneInfoType	FaceZoneInfoType
	Alias for CffFaceZoneInfoType ('C++' API only)

typedef CffCellZoneInfoType	CellZoneInfoType
	Alias for CffCellZoneInfoType ('C++' API only)

typedef CffFaceZonePropType	FaceZonePropType
	Alias for CffFaceZonePropType ('C++' API only)

typedef CffZoneStringInfoType	ZoneStringInfoType
	Alias for CffZoneStringInfoType ('C++' API only)

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

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

typedef CffDataPrecisionType	DataPrecisionType
	Alias for CffDataPrecisionType ('C++' API only)

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

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

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

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

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

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

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

Functions
void ANSYS_FLUIDS_CFFINTERFACE_DLL	printSDKVersion ()
	Writes the ANSYS CFF SDK version message to cout.

void ANSYS_FLUIDS_CFFINTERFACE_DLL	printCopyrightNotice ()
	Writes the standard ANSYS CFF SDK copyright message to cout.

ANSYS_FLUIDS_FACTORY_DLL CffFileProvider *	getDataProvider (const std::string &sourceFile)
	A function that provides that obtains an instance of an ansys::CffFileProvider that can be used to read data from the supplied file name. More...

ANSYS_FLUIDS_FACTORY_DLL std::string	determineSolverType (const std::string &sourceFile)
	Determines the file format of a file and returns as a string. More...

ANSYS_FLUIDS_FACTORY_DLL FileFormatType	determineFileFormat (const std::string &sourceFile)
	Determines the file format of a file and returns as ansys::FileFormatType. More...

Detailed Description

Function Documentation

◆ determineFileFormat()

FileFormatType ansys::determineFileFormat ( const std::string & sourceFile )

Determines the file format of a file and returns as ansys::FileFormatType.

Parameters

sourceFile [in] - The name of the file

Returns: A value representing the type of the file

◆ determineSolverType()

std::string ansys::determineSolverType ( const std::string & sourceFile )

Determines the file format of a file and returns as a string.

Parameters

sourceFile [in] - The name of the file

Returns: - A string representing the type of the file

◆ getDataProvider()

CffFileProvider * ansys::getDataProvider ( const std::string & sourceFile )

A function that provides that obtains an instance of an ansys::CffFileProvider that can be used to read data from the supplied file name.

Parameters

sourceFile [in] - The name of the file for which to obtain a provider

Returns: - A value ansys::CffFileProvider object or nullptr

Common Fluids Format 2024 R1

ansys Namespace Reference

Classes

Typedefs

Functions

Detailed Description

Function Documentation

◆ determineFileFormat()

◆ determineSolverType()

◆ getDataProvider()

Connect with Ansys