## On this page

  

 

 # ansys Namespace Reference

 Last update: 16.07.2025 

## <a id="nested-classes" name="nested-classes"></a>Classes

class [CffBase](classansys_1_1_cff_base.xhtml) Base class that provides common function used by both [CffConsumer](classansys_1_1_cff_consumer.xhtml "Class that provides functions to write data within a CFF database. The database may be stored within ...") and [CffProvider](classansys_1_1_cff_provider.xhtml "Class that provides functions to access data stored within a CFF database. The database may be stored...") classes. [More...](classansys_1_1_cff_base.xhtml#details)  
 class [CffConsumer](classansys_1_1_cff_consumer.xhtml) 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...](classansys_1_1_cff_consumer.xhtml#details)  
 class [CffDataTypeTrait](classansys_1_1_cff_data_type_trait.xhtml) class [CffFileConsumer](classansys_1_1_cff_file_consumer.xhtml) Class that provides functions to access data stored within a CFF file. [More...](classansys_1_1_cff_file_consumer.xhtml#details)  
 class [CffFileIO](classansys_1_1_cff_file_i_o.xhtml) Base class that provides common function used in File providers such as [ansys::CffFileProvider](classansys_1_1_cff_file_provider.xhtml "Class that provides functions to access data stored within a CFF file."). [More...](classansys_1_1_cff_file_i_o.xhtml#details)  
 class [CffFileProvider](classansys_1_1_cff_file_provider.xhtml) Class that provides functions to access data stored within a CFF file. [More...](classansys_1_1_cff_file_provider.xhtml#details)  
 class [CffLocationModel](classansys_1_1_cff_location_model.xhtml) A Topology model providing user visible topological names. [More...](classansys_1_1_cff_location_model.xhtml#details)  
 class [CffProvider](classansys_1_1_cff_provider.xhtml) 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...](classansys_1_1_cff_provider.xhtml#details)  
 class [CffVersion](classansys_1_1_cff_version.xhtml) Provides some basic version extraction and comparison functions. [More...](classansys_1_1_cff_version.xhtml#details)  
 struct [LocationModelData](structansys_1_1_location_model_data.xhtml) ## <a id="typedef-members" name="typedef-members"></a>Typedefs

typedef [CffMeshIdType](group__typedefs.xhtml#ga9be1a8a186916d6989ca9cb5478f7e0a) **MeshIdType** Alias for [CffMeshIdType](group__typedefs.xhtml#ga9be1a8a186916d6989ca9cb5478f7e0a) ('C++' API only)   
 typedef [CffPartitionIdType](group__typedefs.xhtml#gaa2900d4098613674b18dedb187b15bc8) **PartitionIdType** Alias for [CffPartitionIdType](group__typedefs.xhtml#gaa2900d4098613674b18dedb187b15bc8) ('C++' API only)   
 typedef [CffVersionType](group__typedefs.xhtml#gaf564b7920dbc6633757990ca3de4a62c) **VersionType** Alias for [CffVersionType](group__typedefs.xhtml#gaf564b7920dbc6633757990ca3de4a62c) ('C++' API only)   
 typedef [CffNodeCountType](group__typedefs.xhtml#gab6dc29627bd950ece46663a4cadaea43) **NodeCountType** alais for [CffNodeCountType](group__typedefs.xhtml#gab6dc29627bd950ece46663a4cadaea43) ('C++' API only)   
 typedef [CffCountType](group__typedefs.xhtml#ga801ccbb42f0aebc9191863155720e5d3) **CountType** Alias for [CffCountType](group__typedefs.xhtml#ga801ccbb42f0aebc9191863155720e5d3) ('C++' API only)   
 typedef [CffElemIdType](group__typedefs.xhtml#gae0443d06671ffe5d095a04d641d834c8) **ElemIdType** Alias for [CffElemIdType](group__typedefs.xhtml#gae0443d06671ffe5d095a04d641d834c8) ('C++' API only)   
 typedef [CffSectionIdType](group__typedefs.xhtml#ga91fbf130c42e6949e811dfdac69cf0b2) **SectionIdType** Alias for [CffSectionIdType](group__typedefs.xhtml#ga91fbf130c42e6949e811dfdac69cf0b2) ('C++' API only)   
 typedef [CffIOMode](group__enums.xhtml#ga5820566c2439fe2d74130fb1d323dd6c) **IOMode** Alias for [CffIOMode](group__enums.xhtml#ga5820566c2439fe2d74130fb1d323dd6c) ('C++' API only)   
 typedef [CffDataCacheMode](group__enums.xhtml#gab5cfcacaebd813ca2dee1b2eb583ba80) **DataCacheMode** Alias for [CffDataCacheMode](group__enums.xhtml#gab5cfcacaebd813ca2dee1b2eb583ba80) ('C++' API only)   
 typedef [CffTargetCategory](group__enums.xhtml#ga2bf8717ca5a1d17190dddf5faf6efa5d) **TargetCategory** Alias for [CffTargetCategory](group__enums.xhtml#ga2bf8717ca5a1d17190dddf5faf6efa5d) ('C++' API only)   
 typedef [CffVariableDimensionType](group__typedefs.xhtml#gad455e246d7310bb15336a1176b350b10) **VariableDimensionType** Alias for [CffVariableDimensionType](group__typedefs.xhtml#gad455e246d7310bb15336a1176b350b10) ('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&lt; [AttributeName](group__typedefs.xhtml#gafe05ca5c613fa0a0b097c5fbdad6ba07) &gt; **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](group__typedefs.xhtml#ga2c2a3e6622924a70fecb0fb307b2ea7a) **TimeLevelType** Alias for [CffTimeLevelType](group__typedefs.xhtml#ga2c2a3e6622924a70fecb0fb307b2ea7a) ('C++' API only)   
 typedef std::vector&lt; [TimeLevelType](group__typedefs.xhtml#gabedb5244490da90f6098241bdc88e24c) &gt; **TimeLevels** Type used to represent a number of time levels ('C++' API only)   
 typedef std::vector&lt; [MeshIdType](group__typedefs.xhtml#ga9a6c5565b81f965277b48f14355a38ae) &gt; **MeshIds** Type used to represent a number of mesh identifiers ('C++' API only)   
 typedef std::vector&lt; [PartitionIdType](group__typedefs.xhtml#gaa0b01fb68d68067022164a7fcb5cb0e5) &gt; **PartitionIds** Type used to represent a number of partition identifiers ('C++' API only)   
 typedef std::vector&lt; [TargetCategory](group__enums.xhtml#ga2bf8717ca5a1d17190dddf5faf6efa5d) &gt; **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&lt; [CategoryName](group__typedefs.xhtml#gaa2122630c8f73fb0367d48ff4fb21821) &gt; **CategoryNames** Type used to represent a number of category names ('C++' API only)   
 typedef [CffZoneIdType](group__typedefs.xhtml#ga66a5d1b93ef250b01f99e78e49b56528) **ZoneIdType** Alias for [CffZoneIdType](group__typedefs.xhtml#ga66a5d1b93ef250b01f99e78e49b56528) ('C++' API only)   
 typedef std::vector&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; **ZoneIds** Type used to represent a number of zone identifiers('C++' API only)   
 typedef [CffPhaseIdType](group__typedefs.xhtml#ga558b43878a7e6be9adc2a7bd8007396c) **PhaseIdType** Alias for [CffPhaseIdType](group__typedefs.xhtml#ga558b43878a7e6be9adc2a7bd8007396c) ('C++' API only)   
 typedef std::vector&lt; [PhaseIdType](group__typedefs.xhtml#gac3312714419db4aa206bdeda4efa9223) &gt; **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&lt; [PhaseName](group__typedefs.xhtml#gaec2c2963724097e7a913a6645b545682) &gt; **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&lt; [InjectionName](group__typedefs.xhtml#gaefaf48447c0a4b8d332b0168b780b838) &gt; **InjectionNames** Type used to represent a number of particle injection names ('C++' API only)   
 typedef [CffVariableIdType](group__typedefs.xhtml#ga24bc7f0f86252aaa4c04631659ca4d6b) **VariableIdType** Type used to represent the identifier of a variable ('C++' API only)   
 typedef std::vector&lt; [VariableIdType](group__typedefs.xhtml#gae1bb05c41fbbd2e21c7b62cbe214b4be) &gt; **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&lt; [VariableName](group__typedefs.xhtml#ga8b6411ff43380610eb20ed6f2e55292f) &gt; **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&lt; [GroupName](group__typedefs.xhtml#gaf40db5f5ddd5fbf05646e68948648412) &gt; **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](group__enums.xhtml#gaf5d669ab21b6699ea497958b17c32002) **MeshSizeType** Alias for [CffMeshSizeType](group__enums.xhtml#gaf5d669ab21b6699ea497958b17c32002) ('C++' API only)   
 typedef [CffZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b) **ZoneCategory** Alias for [CffZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b) ('C++' API only)   
 typedef [CffZoneSizeType](group__enums.xhtml#ga54ba682a6deedd60cb203d1963a0ac12) **ZoneSizeType** Alias for [CffZoneSizeType](group__enums.xhtml#ga54ba682a6deedd60cb203d1963a0ac12) ('C++' API only)   
 typedef [CffNodeZoneInfoType](group__enums.xhtml#gacc3f469fa6326c4b75b40d9e4f8313db) **NodeZoneInfoType** Alias for [CffNodeZoneInfoType](group__enums.xhtml#gacc3f469fa6326c4b75b40d9e4f8313db) ('C++' API only)   
 typedef [CffEdgeZoneInfoType](group__enums.xhtml#gab5510fa8ae80e1c0e3f4d17207ac2cf8) **EdgeZoneInfoType** Alias for [CffEdgeZoneInfoType](group__enums.xhtml#gab5510fa8ae80e1c0e3f4d17207ac2cf8) ('C++' API only)   
 typedef [CffFaceZoneInfoType](group__enums.xhtml#ga90bd9c961be9a1b7e7d014e9f04588e3) **FaceZoneInfoType** Alias for [CffFaceZoneInfoType](group__enums.xhtml#ga90bd9c961be9a1b7e7d014e9f04588e3) ('C++' API only)   
 typedef [CffCellZoneInfoType](group__enums.xhtml#gaaffda1f82c7b51d603aff684c9ab0cd2) **CellZoneInfoType** Alias for [CffCellZoneInfoType](group__enums.xhtml#gaaffda1f82c7b51d603aff684c9ab0cd2) ('C++' API only)   
 typedef [CffFaceZonePropType](group__enums.xhtml#gadf13e7806827f3d0db8ecb550aa50384) **FaceZonePropType** Alias for [CffFaceZonePropType](group__enums.xhtml#gadf13e7806827f3d0db8ecb550aa50384) ('C++' API only)   
 typedef [CffZoneStringInfoType](group__enums.xhtml#ga7fe67117cb23bbcbb4ff2d5b55c3a704) **ZoneStringInfoType** Alias for [CffZoneStringInfoType](group__enums.xhtml#ga7fe67117cb23bbcbb4ff2d5b55c3a704) ('C++' API only)   
 typedef [CffPlainDataType](group__enums.xhtml#gaa26eac1911cb4a05854b39ca3d909615) **PlainDataType** Alias for [CffPlainDataType](group__enums.xhtml#gaa26eac1911cb4a05854b39ca3d909615) ('C++' API only)   
 typedef [CffDataClass](group__enums.xhtml#gab852cc24891eb831942fb8da764d8ddb) **DataClass** Alias for [CffDataClass](group__enums.xhtml#gab852cc24891eb831942fb8da764d8ddb) ('C++' API only)   
 typedef [CffDataPrecisionType](group__enums.xhtml#ga2ecbf04cb65f31fde87a9c60a5bab3d6) **DataPrecisionType** Alias for [CffDataPrecisionType](group__enums.xhtml#ga2ecbf04cb65f31fde87a9c60a5bab3d6) ('C++' API only)   
 typedef [CffNodeZoneType](group__enums.xhtml#gacdbb57644acedc23cecd46a635289471) **NodeZoneType** Alias for [CffNodeZoneType](group__enums.xhtml#gacdbb57644acedc23cecd46a635289471) ('C++' API only)   
 typedef [CffEdgeZoneType](group__enums.xhtml#gac0bfa43991cd91c6cc7045a2596e36bf) **EdgeZoneType** Alias for [CffEdgeZoneType](group__enums.xhtml#gac0bfa43991cd91c6cc7045a2596e36bf) ('C++' API only)   
 typedef [CffFaceZoneType](group__enums.xhtml#ga13c2dd97c5e14c90a074a2c603ec2bc3) **FaceZoneType** Alias for [CffFaceZoneType](group__enums.xhtml#ga13c2dd97c5e14c90a074a2c603ec2bc3) ('C++' API only)   
 typedef [CffEdgeType](group__enums.xhtml#ga1782918710d976acec410e7fcc95875f) **EdgeType** Alias for [CffEdgeType](group__enums.xhtml#ga1782918710d976acec410e7fcc95875f) ('C++' API only)   
 typedef [CffFaceType](group__enums.xhtml#ga32812d6a5501e53b26fd7200472de3fe) **FaceType** Alias for [CffFaceType](group__enums.xhtml#ga32812d6a5501e53b26fd7200472de3fe) ('C++' API only)   
 typedef [CffCellType](group__enums.xhtml#gac0b3f753b9307362895e46aaa1a9f366) **CellType** Alias for [CffCellType](group__enums.xhtml#gac0b3f753b9307362895e46aaa1a9f366) ('C++' API only)   
 typedef [CffFileFormatType](group__enums.xhtml#ga9d98ab88553e163862440763fc91c76a) **FileFormatType** Alias for [CffFileFormatType](group__enums.xhtml#ga9d98ab88553e163862440763fc91c76a) ('C++' API only)   
 ## <a id="func-members" name="func-members"></a>Functions

<a id="aa9b8e96c9c3dd83f83d9a40d9721f6a1" name="aa9b8e96c9c3dd83f83d9a40d9721f6a1"></a>void ANSYS\_FLUIDS\_CFFINTERFACE\_DLL **printSDKVersion** () Writes the ANSYS CFF SDK version message to cout.   
 <a id="a1213f502fb1f25a1a2525985162c53be" name="a1213f502fb1f25a1a2525985162c53be"></a>void ANSYS\_FLUIDS\_CFFINTERFACE\_DLL **printCopyrightNotice** () Writes the standard ANSYS CFF SDK copyright message to cout.   
 ANSYS\_FLUIDS\_FACTORY\_DLL [CffFileProvider](classansys_1_1_cff_file_provider.xhtml) \* [getDataProvider](namespaceansys.xhtml#a2f23564ea3eec12f9b204a64356e88c1) (const std::string &amp;sourceFile) A function that provides that obtains an instance of an [ansys::CffFileProvider](classansys_1_1_cff_file_provider.xhtml "Class that provides functions to access data stored within a CFF file.") that can be used to read data from the supplied file name. [More...](namespaceansys.xhtml#a2f23564ea3eec12f9b204a64356e88c1)  
 ANSYS\_FLUIDS\_FACTORY\_DLL std::string [determineSolverType](namespaceansys.xhtml#a1d30f3cd4bef43980f48d3a81b355d7b) (const std::string &amp;sourceFile) Determines the file format of a file and returns as a string. [More...](namespaceansys.xhtml#a1d30f3cd4bef43980f48d3a81b355d7b)  
 ANSYS\_FLUIDS\_FACTORY\_DLL [FileFormatType](group__enums.xhtml#ga9d98ab88553e163862440763fc91c76a) [determineFileFormat](namespaceansys.xhtml#a91e89789b1107a54cab3e3c359ffc1b8) (const std::string &amp;sourceFile) Determines the file format of a file and returns as [ansys::FileFormatType](group__typedefs.xhtml#ga9108150c3c8342b9a631edd15f179580). [More...](namespaceansys.xhtml#a91e89789b1107a54cab3e3c359ffc1b8)  
 <a id="details" name="details"></a>## Detailed Description

Copyright ANSYS. All Rights Reserved.



## Function Documentation

<a id="a91e89789b1107a54cab3e3c359ffc1b8" name="a91e89789b1107a54cab3e3c359ffc1b8"></a>## [◆ ](#a91e89789b1107a54cab3e3c359ffc1b8)determineFileFormat()

 [FileFormatType](group__enums.xhtml#ga9d98ab88553e163862440763fc91c76a) ansys::determineFileFormat  ( const std::string &amp;  *sourceFile*) 

Determines the file format of a file and returns as [ansys::FileFormatType](group__typedefs.xhtml#ga9108150c3c8342b9a631edd15f179580).

Parameters sourceFile\[in\] - The name of the file ReturnsA value representing the type of the file 



<a id="a1d30f3cd4bef43980f48d3a81b355d7b" name="a1d30f3cd4bef43980f48d3a81b355d7b"></a>## [◆ ](#a1d30f3cd4bef43980f48d3a81b355d7b)determineSolverType()

 std::string ansys::determineSolverType  ( const std::string &amp;  *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 



<a id="a2f23564ea3eec12f9b204a64356e88c1" name="a2f23564ea3eec12f9b204a64356e88c1"></a>## [◆ ](#a2f23564ea3eec12f9b204a64356e88c1)getDataProvider()

 [CffFileProvider](classansys_1_1_cff_file_provider.xhtml) \* ansys::getDataProvider  ( const std::string &amp;  *sourceFile*) 

A function that provides that obtains an instance of an [ansys::CffFileProvider](classansys_1_1_cff_file_provider.xhtml "Class that provides functions to access data stored within a CFF file.") 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](classansys_1_1_cff_file_provider.xhtml) object or nullptr