## On this page

  

 

 # ansys::CffBase Class Reference

 Last update: 24.03.2026 

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)

`#include "CffInterface/CffBase.hpp"`

Inheritance diagram for ansys::CffBase:

 ![](/sites/default/files/migrate-content/common_fluids_format_2026_r1_1/classansys_1_1_cff_base.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [CffBase](classansys_1_1_cff_base.xhtml#a8e91a34b6ff2e403b674b5f7eabbd30d) () Constructor. [More...](classansys_1_1_cff_base.xhtml#a8e91a34b6ff2e403b674b5f7eabbd30d)  
 virtual [~CffBase](classansys_1_1_cff_base.xhtml#a20caf165b9dd7454fc7792d61e14eb7e) () Destructor. [More...](classansys_1_1_cff_base.xhtml#a20caf165b9dd7454fc7792d61e14eb7e)  
 void [setPartitionId](classansys_1_1_cff_base.xhtml#acd0f72767680be525a7445e07fb3b9ba) (const [PartitionIdType](group__typedefs.xhtml#gaa0b01fb68d68067022164a7fcb5cb0e5) pId) [PartitionIdType](group__typedefs.xhtml#gaa0b01fb68d68067022164a7fcb5cb0e5) [getPartitionId](classansys_1_1_cff_base.xhtml#aebfbe683df8687fd15685c7cf5e2dbe9) () const virtual void [setDebugOn](classansys_1_1_cff_base.xhtml#a762f990aefce5b11164a58d2721bd350) (bool debug) Turn on/off debugging information. [More...](classansys_1_1_cff_base.xhtml#a762f990aefce5b11164a58d2721bd350)  
 virtual void [setReadNCIOn](classansys_1_1_cff_base.xhtml#a7580864520aebd0a63c0e3f4490c8ea3) (bool readNCI) Turn on/off non-conformal interface reading. [More...](classansys_1_1_cff_base.xhtml#a7580864520aebd0a63c0e3f4490c8ea3)  
 

void [setMeshId](classansys_1_1_cff_base.xhtml#a7a12ef6589a193f80be541291b0cec4b) (const [MeshIdType](group__typedefs.xhtml#ga9a6c5565b81f965277b48f14355a38ae) meshId) Set the Identifier for active mesh being read or written. [More...](classansys_1_1_cff_base.xhtml#a7a12ef6589a193f80be541291b0cec4b)  
 [MeshIdType](group__typedefs.xhtml#ga9a6c5565b81f965277b48f14355a38ae) [getMeshId](classansys_1_1_cff_base.xhtml#a38bd51885eca5de0f72d49db6bff1ffb) () const Get the Identifier of the active mesh. [More...](classansys_1_1_cff_base.xhtml#a38bd51885eca5de0f72d49db6bff1ffb)  
 

void [setTarget](classansys_1_1_cff_base.xhtml#a8f9c0f2adda371644dfe678da1bdd9a2) (const [TargetCategory](group__enums.xhtml#ga2bf8717ca5a1d17190dddf5faf6efa5d) target) Set the target category for which the data is intended. [More...](classansys_1_1_cff_base.xhtml#a8f9c0f2adda371644dfe678da1bdd9a2)  
 [TargetCategory](group__enums.xhtml#ga2bf8717ca5a1d17190dddf5faf6efa5d) [getTarget](classansys_1_1_cff_base.xhtml#a9ed7e905d291697c22f073ee8482ec40) () const Get the target category for which the data is intended. [More...](classansys_1_1_cff_base.xhtml#a9ed7e905d291697c22f073ee8482ec40)  
 

void [setMeshSize](classansys_1_1_cff_base.xhtml#a259b65322ef0d42859d988166eed23d7) (const [MeshSizeType](group__enums.xhtml#gaf5d669ab21b6699ea497958b17c32002) type, const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107) size) Sets a value that defines the dimension or the global number of objects of a specific mesh entity. [More...](classansys_1_1_cff_base.xhtml#a259b65322ef0d42859d988166eed23d7)  
 void [getMeshSize](classansys_1_1_cff_base.xhtml#acaf3eef987d98a7af34c15b9b7954abc) (const [MeshSizeType](group__enums.xhtml#gaf5d669ab21b6699ea497958b17c32002) type, [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107) &amp;size) const Obtains a value that defines the dimension or the global number of objects of a specific mesh entity. [More...](classansys_1_1_cff_base.xhtml#acaf3eef987d98a7af34c15b9b7954abc)  
 

void [setMeshUnits](classansys_1_1_cff_base.xhtml#ae323125334ed9fb3d4d62796e08a8451) (const std::string &amp;units="m") Define the units of length the mesh is defined in. [More...](classansys_1_1_cff_base.xhtml#ae323125334ed9fb3d4d62796e08a8451)  
 void [getMeshUnits](classansys_1_1_cff_base.xhtml#a1f85337345d893d33c9cfcdd0431757a) (std::string &amp;unit) const Obtains the unit of length the mesh is defined in. [More...](classansys_1_1_cff_base.xhtml#a1f85337345d893d33c9cfcdd0431757a)  
 

void [setZoneIds](classansys_1_1_cff_base.xhtml#a39f93ca4fe18b77774bf8e8de49761e0) (const [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b) zoneCategory, const [ZoneIds](group__typedefs.xhtml#ga93b257990d79f628e301fb5e39125cfa) &amp;zonesIds) Define the zones that are of a specific category. [More...](classansys_1_1_cff_base.xhtml#a39f93ca4fe18b77774bf8e8de49761e0)  
 virtual size\_t [getNumZones](classansys_1_1_cff_base.xhtml#a3cfe9f0e37df52d9d9a0d0846f01be44) (const [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b)) const Returns the number of zones in a specific category. [More...](classansys_1_1_cff_base.xhtml#a3cfe9f0e37df52d9d9a0d0846f01be44)  
 virtual void [getZoneIds](classansys_1_1_cff_base.xhtml#a27eedb8c5bce9f6df83472ad4f3e02bd) (const [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b) zoneCategory, [ZoneIds](group__typedefs.xhtml#ga93b257990d79f628e301fb5e39125cfa) &amp;zoneIds) const Request the collection of zone Ids that are of a specific category.   
[More...](classansys_1_1_cff_base.xhtml#a27eedb8c5bce9f6df83472ad4f3e02bd)  
 

void [setNodeZoneInfo](classansys_1_1_cff_base.xhtml#af769e3a822ffc4c0fdf1a729c166c9cb) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) nodeZoneId, const [NodeZoneInfoType](group__enums.xhtml#gacc3f469fa6326c4b75b40d9e4f8313db) nodeZoneInfoType, const int info) const set certain zone level info for a node zone.   
[More...](classansys_1_1_cff_base.xhtml#af769e3a822ffc4c0fdf1a729c166c9cb)  
 void [getNodeZoneInfo](classansys_1_1_cff_base.xhtml#a5a38fe3bcf5c8c129c6691b5c57440e9) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) nodeZoneId, const [NodeZoneInfoType](group__enums.xhtml#gacc3f469fa6326c4b75b40d9e4f8313db) nodeZoneInfoType, int &amp;info) const get certain zone level info for a node zone.   
[More...](classansys_1_1_cff_base.xhtml#a5a38fe3bcf5c8c129c6691b5c57440e9)  
 

void [setAllFaceZoneFlags](classansys_1_1_cff_base.xhtml#abb3c12f95d090dd9df153008b6515ed7) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) faceZoneId, const int allFlags) Set flags for a face zone. [More...](classansys_1_1_cff_base.xhtml#abb3c12f95d090dd9df153008b6515ed7)  
 void [getAllFaceZoneFlags](classansys_1_1_cff_base.xhtml#a3a07688c012e35b57939fe2a94ae7bf6) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) faceZoneId, int &amp;allFlags) const Get flags for a face zone. [More...](classansys_1_1_cff_base.xhtml#a3a07688c012e35b57939fe2a94ae7bf6)  
 

void [setFaceZoneType](classansys_1_1_cff_base.xhtml#a95e9e01481576f3f34c3b2276215fab7) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) faceZoneId, const [FaceZoneType](group__enums.xhtml#ga13c2dd97c5e14c90a074a2c603ec2bc3) zoneType) set zone type of a face zone. [More...](classansys_1_1_cff_base.xhtml#a95e9e01481576f3f34c3b2276215fab7)  
 void [getFaceZoneType](classansys_1_1_cff_base.xhtml#a54f28797f4937e10436099ce2aeacfb9) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) faceZoneId, [FaceZoneType](group__enums.xhtml#ga13c2dd97c5e14c90a074a2c603ec2bc3) &amp;zoneType) const get the zone type of a face zone. [More...](classansys_1_1_cff_base.xhtml#a54f28797f4937e10436099ce2aeacfb9)  
 

void [setFaceZoneInfo](classansys_1_1_cff_base.xhtml#a5c7a587b4206497cf6b9608c41d6b543) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) faceZoneId, const [FaceZoneInfoType](group__enums.xhtml#ga90bd9c961be9a1b7e7d014e9f04588e3) faceZoneInfoType, const int info) const set certain zone level info for a face zone. [More...](classansys_1_1_cff_base.xhtml#a5c7a587b4206497cf6b9608c41d6b543)  
 void [getFaceZoneInfo](classansys_1_1_cff_base.xhtml#af7d98ff434df5ca813e0abc6fcda06b5) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) faceZoneId, const [FaceZoneInfoType](group__enums.xhtml#ga90bd9c961be9a1b7e7d014e9f04588e3) faceZoneInfoType, int &amp;info) const get certain zone level info for a face zone. [More...](classansys_1_1_cff_base.xhtml#af7d98ff434df5ca813e0abc6fcda06b5)  
 

void [setFaceZoneProp](classansys_1_1_cff_base.xhtml#a9fd0b6d7cec6f6bf0d1d49be26f7d55d) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) faceZoneId, const [FaceZonePropType](group__enums.xhtml#gadf13e7806827f3d0db8ecb550aa50384) faceZonePropType) bool [getFaceZoneProp](classansys_1_1_cff_base.xhtml#a6916863ecd01e1a7f61660c64cf64b85) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) faceZoneId, const [FaceZonePropType](group__enums.xhtml#gadf13e7806827f3d0db8ecb550aa50384)) const 

void [setZoneSizeInfo](classansys_1_1_cff_base.xhtml#ab004b191ee5ecb3c4e601e8fdad56c1a) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) zoneId, const [ZoneSizeType](group__enums.xhtml#ga54ba682a6deedd60cb203d1963a0ac12) sizeType, const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107) size) Sets a size setting of a zone. [More...](classansys_1_1_cff_base.xhtml#ab004b191ee5ecb3c4e601e8fdad56c1a)  
 void [getZoneSizeInfo](classansys_1_1_cff_base.xhtml#a3288b67c94eebe85133afbf5c6329a73) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) zoneId, const [ZoneSizeType](group__enums.xhtml#ga54ba682a6deedd60cb203d1963a0ac12) sizeType, [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107) &amp;size) const Obtains a size setting of a zone. [More...](classansys_1_1_cff_base.xhtml#a3288b67c94eebe85133afbf5c6329a73)  
 

void [setCellZoneInfo](classansys_1_1_cff_base.xhtml#a4fad271e6ee24cc9de5fca8e0990e558) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) cellZoneId, const [CellZoneInfoType](group__enums.xhtml#gaaffda1f82c7b51d603aff684c9ab0cd2) cellZoneInfoType, const int info) set certain zone level info for a cell zone. [More...](classansys_1_1_cff_base.xhtml#a4fad271e6ee24cc9de5fca8e0990e558)  
 void [getCellZoneInfo](classansys_1_1_cff_base.xhtml#a8cdb470e83dfbe98fda9597e5908570d) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) cellZoneId, const [CellZoneInfoType](group__enums.xhtml#gaaffda1f82c7b51d603aff684c9ab0cd2) cellZoneInfoType, int &amp;info) const get certain zone level info for a cell zone. [More...](classansys_1_1_cff_base.xhtml#a8cdb470e83dfbe98fda9597e5908570d)  
 

void [setEdgeZoneType](classansys_1_1_cff_base.xhtml#a022ca55715eb4c7a1f46e7c1c7c899f3) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) edgeZoneId, const [EdgeZoneType](group__enums.xhtml#gac0bfa43991cd91c6cc7045a2596e36bf) zoneType) set zone type of a edge zone.   
[More...](classansys_1_1_cff_base.xhtml#a022ca55715eb4c7a1f46e7c1c7c899f3)  
 void [getEdgeZoneType](classansys_1_1_cff_base.xhtml#a338831ea194619a576aa15aa96f479f8) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) edgeZoneId, [EdgeZoneType](group__enums.xhtml#gac0bfa43991cd91c6cc7045a2596e36bf) &amp;zoneType) const get the zone type of a edge zone. [More...](classansys_1_1_cff_base.xhtml#a338831ea194619a576aa15aa96f479f8)  
 

void [setEdgeZoneInfo](classansys_1_1_cff_base.xhtml#a4deb6b8c569d92acabf1c0bd85a4f35f) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) edgeZoneId, const [EdgeZoneInfoType](group__enums.xhtml#gab5510fa8ae80e1c0e3f4d17207ac2cf8) edgeZoneInfoType, const int info) set certain zone level info for a edge zone. [More...](classansys_1_1_cff_base.xhtml#a4deb6b8c569d92acabf1c0bd85a4f35f)  
 void [getEdgeZoneInfo](classansys_1_1_cff_base.xhtml#a781704a9b5db32ad76674f0d76ff1c82) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) edgeZoneId, const [EdgeZoneInfoType](group__enums.xhtml#gab5510fa8ae80e1c0e3f4d17207ac2cf8) edgeZoneInfoType, int &amp;info) const get certain zone level info for a edge zone. [More...](classansys_1_1_cff_base.xhtml#a781704a9b5db32ad76674f0d76ff1c82)  
 

void [setZoneStringInfo](classansys_1_1_cff_base.xhtml#a41dad7e9d021bdda73c87fe328dc8165) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) zoneId, const [ZoneStringInfoType](group__enums.xhtml#ga7fe67117cb23bbcbb4ff2d5b55c3a704) type, const std::string &amp;info) Sets a string value associated with a zone. [More...](classansys_1_1_cff_base.xhtml#a41dad7e9d021bdda73c87fe328dc8165)  
 void [getZoneStringInfo](classansys_1_1_cff_base.xhtml#a996240e5d9daecbd1a2fca41931e6857) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) zoneId, const [ZoneStringInfoType](group__enums.xhtml#ga7fe67117cb23bbcbb4ff2d5b55c3a704) type, std::string &amp;info) const Obtains a string value associated with a zone. [More...](classansys_1_1_cff_base.xhtml#a996240e5d9daecbd1a2fca41931e6857)  
 

void [getFaceCellZone0Ids](classansys_1_1_cff_base.xhtml#aed5f714fd202db49f2d5dbc643f8ae0b) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) faceZoneId, std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &amp;zoneIds) Get a list of cell zones on side zero of a face zone. [More...](classansys_1_1_cff_base.xhtml#aed5f714fd202db49f2d5dbc643f8ae0b)  
 void [getFaceCellZone1Ids](classansys_1_1_cff_base.xhtml#a5b3ac69ef66941dc47ac51567da0e811) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) faceZoneId, std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &amp;zoneIds) Get a list of cell zones on side one of a face zone. [More...](classansys_1_1_cff_base.xhtml#a5b3ac69ef66941dc47ac51567da0e811)  
 void [getCellFaceZoneIds](classansys_1_1_cff_base.xhtml#aefdb444e036bf2bde4727ca122985a06) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) cellZoneId, std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &amp;zoneIds) Get a list of face zones touching a cell zone. [More...](classansys_1_1_cff_base.xhtml#aefdb444e036bf2bde4727ca122985a06)  
 

virtual void [setSolverType](classansys_1_1_cff_base.xhtml#a30ca8450d5f621a2decc2dde0ff9207f) ([SolverType](group__typedefs.xhtml#ga195806ab92eb9a11e3bda91098c6ac38) solverType) Set the name of the application that is supplying the data. [More...](classansys_1_1_cff_base.xhtml#a30ca8450d5f621a2decc2dde0ff9207f)  
 [SolverType](group__typedefs.xhtml#ga195806ab92eb9a11e3bda91098c6ac38) [getSolverType](classansys_1_1_cff_base.xhtml#aac055e13c1b7040833aa2d981a606486) () const Obtains the owner of the data in the model. [More...](classansys_1_1_cff_base.xhtml#aac055e13c1b7040833aa2d981a606486)  
 

const [CffLocationModel](classansys_1_1_cff_location_model.xhtml) \* [getLocationModel](classansys_1_1_cff_base.xhtml#a6ef0a23c0b31c58b1a70e8c7abdb3cb9) () const Get a query interface to the underlying topology model. [More...](classansys_1_1_cff_base.xhtml#a6ef0a23c0b31c58b1a70e8c7abdb3cb9)  
 

void [setVariableAttributeProvider](classansys_1_1_cff_base.xhtml#af65917c8ea7a2165f19462275e4fdc11) (const CffVariableAttributeProvider \*, bool takeOwnership=false) Register an alternative variable attribute provider. [More...](classansys_1_1_cff_base.xhtml#af65917c8ea7a2165f19462275e4fdc11)  
 

CffMessageRegistrar \* [getMessageRegistrar](classansys_1_1_cff_base.xhtml#ab3cf0c9c550daa3233c0121c06b9a12e) () const Obtains a message registrar object so that external plug-ins can register messages with the API. [More...](classansys_1_1_cff_base.xhtml#ab3cf0c9c550daa3233c0121c06b9a12e)  
 bool [hasError](classansys_1_1_cff_base.xhtml#ae21605b67de8dfdc99ed2dd2436c8276) () const returns whether there are unprocessed error messages registered. [More...](classansys_1_1_cff_base.xhtml#ae21605b67de8dfdc99ed2dd2436c8276)  
 bool [hasWarning](classansys_1_1_cff_base.xhtml#a0c21e26398dc9974f47ca3483ddf5511) () const returns whether there are unprocessed warning messages registered. [More...](classansys_1_1_cff_base.xhtml#a0c21e26398dc9974f47ca3483ddf5511)  
 bool [hasInfo](classansys_1_1_cff_base.xhtml#a9951a635748839427d6f0025ffe52624) () const returns whether there are unprocessed informative messages registered. [More...](classansys_1_1_cff_base.xhtml#a9951a635748839427d6f0025ffe52624)  
 std::vector&lt; std::string &gt; [getErrors](classansys_1_1_cff_base.xhtml#a4ad1f2f007e8a575da4935bbc136ee1a) (bool formated=true, bool clear=false) const returns, as strings, any unprocessed error messages registered [More...](classansys_1_1_cff_base.xhtml#a4ad1f2f007e8a575da4935bbc136ee1a)  
 std::vector&lt; std::string &gt; [getWarnings](classansys_1_1_cff_base.xhtml#ac9b6a55b76b04124c6e0ce8670b27cdf) (bool formated=true, bool clear=false) const returns, as strings, any unprocessed warning messages registered [More...](classansys_1_1_cff_base.xhtml#ac9b6a55b76b04124c6e0ce8670b27cdf)  
 std::vector&lt; std::string &gt; [getInfos](classansys_1_1_cff_base.xhtml#a082d2c3d4dc0c44c918764d25adcadda) (bool formated=true, bool clear=false) const returns, as strings, any unprocessed information messages registered [More...](classansys_1_1_cff_base.xhtml#a082d2c3d4dc0c44c918764d25adcadda)  
 

void [registerSettingsParser](classansys_1_1_cff_base.xhtml#a52f6b4e5a617b22028b2cab38fcbc861) (CffSettingsParser \*) Sets a parser for processing settings. [More...](classansys_1_1_cff_base.xhtml#a52f6b4e5a617b22028b2cab38fcbc861)  
 bool [addSetting](classansys_1_1_cff_base.xhtml#a2ec5c496eb4060808d5c93e7de48afba) (const [DataClass](group__enums.xhtml#gab852cc24891eb831942fb8da764d8ddb) dataClass, const std::string &amp;key, const std::string &amp;value, const [SolverType](group__typedefs.xhtml#ga195806ab92eb9a11e3bda91098c6ac38) &amp;solverType="CFF\_GENERIC") Sets a specific setting by supplying a key and a value. [More...](classansys_1_1_cff_base.xhtml#a2ec5c496eb4060808d5c93e7de48afba)  
 bool [addSettingsDataSet](classansys_1_1_cff_base.xhtml#ac3afd0039522c633e78e643ef5c92c88) (const [DataClass](group__enums.xhtml#gab852cc24891eb831942fb8da764d8ddb) dataClass, const std::string &amp;dataSetPath, const std::string &amp;data, const [SolverType](group__typedefs.xhtml#ga195806ab92eb9a11e3bda91098c6ac38) &amp;solverType="CFF\_GENERIC", const std::vector&lt; std::string &gt; &amp;settingsKeys=std::vector&lt; std::string &gt;()) Defines a set of data that contain the more than one setting. [More...](classansys_1_1_cff_base.xhtml#ac3afd0039522c633e78e643ef5c92c88)  
 ![-](/sites/default/files/migrate-content/common_fluids_format_2026_r1_1/closed.png) Public Member Functions inherited from [ansys::CffVersion](classansys_1_1_cff_version.xhtml) [CffVersion](classansys_1_1_cff_version.xhtml#a9274e8b4fd14afdc71d46fb66dc405cd) ()  [~CffVersion](classansys_1_1_cff_version.xhtml#a3ee0c0a7f11906983671c5b693860430) () ## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

static std::string [\_defaultSettingsPath](classansys_1_1_cff_base.xhtml#a03d5187e85700144661d5dc477714202) = "settings" ## <a id="pro-types" name="pro-types"></a>Protected Types

enum class [UpdateMethod](classansys_1_1_cff_base.xhtml#a1e830177b6b0f3a1ab06bd2679f8a801) { [CaseOnly](classansys_1_1_cff_base.xhtml#a1e830177b6b0f3a1ab06bd2679f8a801aa0021edb3bd3a0360dad3a09fe2c2185) = 1 , [ResultsOnly](classansys_1_1_cff_base.xhtml#a1e830177b6b0f3a1ab06bd2679f8a801ad0a948b0e19dfca30fe1b7fc8745cc52), [CaseAndResults](classansys_1_1_cff_base.xhtml#a1e830177b6b0f3a1ab06bd2679f8a801a3e88061dedbcbe68f2a2b719a774044d) } ## <a id="pro-methods" name="pro-methods"></a>Protected Member Functions

[CffReadable](group__enums.xhtml#ga0fb9773918c961ce8187a074481c3069) [isSupported](classansys_1_1_cff_base.xhtml#a0f6a86dc4029c4ff72ccf893a1247fb1) (const std::string &amp;version) const Check whether the version can be read by this version of the CFF SDK. [More...](classansys_1_1_cff_base.xhtml#a0f6a86dc4029c4ff72ccf893a1247fb1)  
 void [setMeshSize](classansys_1_1_cff_base.xhtml#a5c0728f170c875374eef517fcb4a75fb) (const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107) nDims, const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107) nodesCount, const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107) edgesCount, const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107) facesCount, const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107) 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...](classansys_1_1_cff_base.xhtml#a5c0728f170c875374eef517fcb4a75fb)  
 virtual void [setZoneAdjacency](classansys_1_1_cff_base.xhtml#a5ef5d972c78d183d8d765f1b5578ea57) () void [setFaceCellZone0Ids](classansys_1_1_cff_base.xhtml#ac0abea2487c710f7091853e6519493e7) (const std::map&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96), std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;) 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...](classansys_1_1_cff_base.xhtml#ac0abea2487c710f7091853e6519493e7)  
 void [setFaceCellZone1Ids](classansys_1_1_cff_base.xhtml#a5b3584e853403d6f0fdac43573c60fb0) (const std::map&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96), std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;) 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...](classansys_1_1_cff_base.xhtml#a5b3584e853403d6f0fdac43573c60fb0)  
 void [getFaceCellZone0Ids](classansys_1_1_cff_base.xhtml#acb322a7e2667baee3ae555968a4bb429) (std::map&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96), std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;) void [getFaceCellZone1Ids](classansys_1_1_cff_base.xhtml#ad4fedb6f7158c5340fcc0dd5ebffa790) (std::map&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96), std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;) void [setCellFaceZoneIds](classansys_1_1_cff_base.xhtml#a5f0ef9af551d0fa910224bcd5b2ff012) (const std::map&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96), std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;) 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...](classansys_1_1_cff_base.xhtml#a5f0ef9af551d0fa910224bcd5b2ff012)  
 void [getSortedMinIdZoneId](classansys_1_1_cff_base.xhtml#acd55506ab391dd7dd7e62f51f7aaa2b0) (const [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b), std::vector&lt; std::pair&lt; [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107), [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;minIdZoneId) const std::string [getGroupNameForPhase](classansys_1_1_cff_base.xhtml#af0d21caac7777b939f76735e83984cbe) ([PhaseIdType](group__typedefs.xhtml#gac3312714419db4aa206bdeda4efa9223) phaseId) const CffSolutionModel \* [solutionModel](classansys_1_1_cff_base.xhtml#a91b255a6c333f2f5e302fe61a09e5657) () const virtual void [initLocationModel](classansys_1_1_cff_base.xhtml#a624faedd25141cbf3f46877cfa7a2c53) () const [CffLocationModel](classansys_1_1_cff_location_model.xhtml) \* [locationModel](classansys_1_1_cff_base.xhtml#a022d5e7d262d2f307d305b071844f7b8) () const void [initializeVariableAttributeProvider](classansys_1_1_cff_base.xhtml#a2630b322188a07ec1eeb9b136c73c4e2) (const [SolverType](group__typedefs.xhtml#ga195806ab92eb9a11e3bda91098c6ac38) &amp;solverType, const std::string &amp;variableTarget) virtual bool [updateData](classansys_1_1_cff_base.xhtml#a4705c89685f16a8b76f879dff8d53a4c) ([DataClass](group__enums.xhtml#gab852cc24891eb831942fb8da764d8ddb)) bool [setMeshContext](classansys_1_1_cff_base.xhtml#aa91c9abb97b43c30e006c41852a54486) ([MeshId](namespaceansys.xhtml#ad39fb97de8d4c01dcde3d4d829eee232), [TargetCategory](group__enums.xhtml#ga2bf8717ca5a1d17190dddf5faf6efa5d), [PartitionIdType](group__typedefs.xhtml#gaa0b01fb68d68067022164a7fcb5cb0e5), [UpdateMethod](classansys_1_1_cff_base.xhtml#a1e830177b6b0f3a1ab06bd2679f8a801)=[UpdateMethod::CaseAndResults](classansys_1_1_cff_base.xhtml#a1e830177b6b0f3a1ab06bd2679f8a801a3e88061dedbcbe68f2a2b719a774044d)) virtual void [finalizeMeshContext](classansys_1_1_cff_base.xhtml#a0b1de966137efffa6bd89ed3e26005b0) () 

void [setZoneCategory](classansys_1_1_cff_base.xhtml#a24487deb6252ec704a446743f74dc84a) (const [ZoneIds](group__typedefs.xhtml#ga93b257990d79f628e301fb5e39125cfa) &amp;, const [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b)) set the zone categories of all zones of the same zone category [More...](classansys_1_1_cff_base.xhtml#a24487deb6252ec704a446743f74dc84a)  
 [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b) [getZoneCategory](classansys_1_1_cff_base.xhtml#aefc5f51cf7ed4b2d2f7c887e28edb068) (const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) zoneId) const get the zone category of a given zone by zone id [More...](classansys_1_1_cff_base.xhtml#aefc5f51cf7ed4b2d2f7c887e28edb068)  
 

void [addVariableOfCategory](classansys_1_1_cff_base.xhtml#a5a34019a24cdc2b0198f5fd1f9169579) ([VariableIdType](group__typedefs.xhtml#gae1bb05c41fbbd2e21c7b62cbe214b4be), [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b)) const ## <a id="pro-attribs" name="pro-attribs"></a>Protected Attributes

std::unique\_ptr&lt; DataInterface &gt; [\_data](classansys_1_1_cff_base.xhtml#abe68a138cc582d12caf4fe858a9c8c94) std::unique\_ptr&lt; const CffVariableAttributeProvider &gt; [\_varAttrProvider](classansys_1_1_cff_base.xhtml#a6cc0f9a6020b6a1eb82f705ac2e4a0a2) void [setApplicationName](classansys_1_1_cff_base.xhtml#a37ac2d23d1b21376117cb574ea5aecd5) (const std::string &amp;applicationName) Sets an application name for error purposes and when logging to a file. [More...](classansys_1_1_cff_base.xhtml#a37ac2d23d1b21376117cb574ea5aecd5)  
 std::string [getApplicationName](classansys_1_1_cff_base.xhtml#a2c9e460ac858ffb8050c9e4c30c23eb9) () const Obtains the application name that was set by calling [setApplicationName](classansys_1_1_cff_base.xhtml#a37ac2d23d1b21376117cb574ea5aecd5) logging when writing a file. [More...](classansys_1_1_cff_base.xhtml#a2c9e460ac858ffb8050c9e4c30c23eb9)  
 void [getPhaseIds](classansys_1_1_cff_base.xhtml#af555905619187578ebedc0da9116ae54) ([PhaseIds](group__typedefs.xhtml#ga99ff3bf3b76eac538df4d637faab6b4c) &amp;phaseIds) const Obtain the Identifiers of all Phase. [More...](classansys_1_1_cff_base.xhtml#af555905619187578ebedc0da9116ae54)  
 bool [getPhaseName](classansys_1_1_cff_base.xhtml#ac0e318ff4148977296fd1e7e332a4cb2) (const [PhaseIdType](group__typedefs.xhtml#gac3312714419db4aa206bdeda4efa9223) phaseId, [PhaseName](group__typedefs.xhtml#gaec2c2963724097e7a913a6645b545682) &amp;phaseName) const Obtain the unique name a specific Phase. [More...](classansys_1_1_cff_base.xhtml#ac0e318ff4148977296fd1e7e332a4cb2)  
 [PhaseName](group__typedefs.xhtml#gaec2c2963724097e7a913a6645b545682) [getPhaseName](classansys_1_1_cff_base.xhtml#aaf2782a59cd4e5939299c278f2e2c14d) (const [PhaseIdType](group__typedefs.xhtml#gac3312714419db4aa206bdeda4efa9223) phaseId) const Obtain the unique name a specific Phase. [More...](classansys_1_1_cff_base.xhtml#aaf2782a59cd4e5939299c278f2e2c14d)  
 bool [getActivePhase](classansys_1_1_cff_base.xhtml#ac71e552c0ad9f94ec0b117f544e16dab) ([PhaseIdType](group__typedefs.xhtml#gac3312714419db4aa206bdeda4efa9223) &amp;) const bool [setActivePhase](classansys_1_1_cff_base.xhtml#ab033b5affde5ab8b4ae0ff2bc27a1c57) ([PhaseIdType](group__typedefs.xhtml#gac3312714419db4aa206bdeda4efa9223)) const bool [getActivePhase](classansys_1_1_cff_base.xhtml#afa627cbd51a548d5e9d7357ee0ff879d) ([PhaseName](group__typedefs.xhtml#gaec2c2963724097e7a913a6645b545682) &amp;) const bool [setActivePhase](classansys_1_1_cff_base.xhtml#ae45bcd4e2a15aa09114e4f9767ce7b6a) (const [PhaseName](group__typedefs.xhtml#gaec2c2963724097e7a913a6645b545682) &amp;) const const [TimeLevels](group__typedefs.xhtml#ga05f2423bfbdc98936c0b6e77108a3ceb) &amp; [getTimeLevels](classansys_1_1_cff_base.xhtml#aed5e5b99ed3a9c2f0c99c79f766529f6) () const [TimeLevelType](group__typedefs.xhtml#gabedb5244490da90f6098241bdc88e24c) [getTimeLevel](classansys_1_1_cff_base.xhtml#acd2f82d0cc8278ce20a870e5216dc16b) () const void [addTimeLevel](classansys_1_1_cff_base.xhtml#a61b15533595d9c6fb16b083c1810f362) ([TimeLevelType](group__typedefs.xhtml#gabedb5244490da90f6098241bdc88e24c)) const bool [setTimeLevel](classansys_1_1_cff_base.xhtml#a8070844e08f8fd939cf1a23e1200f374) ([TimeLevelType](group__typedefs.xhtml#gabedb5244490da90f6098241bdc88e24c)) const ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/common_fluids_format_2026_r1_1/closed.png) Static Public Member Functions inherited from [ansys::CffVersion](classansys_1_1_cff_version.xhtml)static unsigned int [getMajor](classansys_1_1_cff_version.xhtml#a6eac2194e4845de8b13fc6654a6061db) () static unsigned int [getMinor](classansys_1_1_cff_version.xhtml#ae580f388b6c6dd9e68db8433749da81e) () static unsigned int [getPatch](classansys_1_1_cff_version.xhtml#ad1139980443eb9200c7c37e1a48433ac) () static std::string [getSHA](classansys_1_1_cff_version.xhtml#a054bb0e156cf7a084145cd536399fcf1) () static bool [isBeta](classansys_1_1_cff_version.xhtml#a49bba0b8a37276210f7e51c425ee4788) () static std::string [apiVersionAsString](classansys_1_1_cff_version.xhtml#aba256dcc082e509be94d1c332a88f1dc) (const std::string &amp;separator=".") static std::string [ansysApplicationVersion](classansys_1_1_cff_version.xhtml#a839a336d8430485ed81d1bafdc6671cc) (const std::string &amp;appName) static std::string [copyright](classansys_1_1_cff_version.xhtml#a36112f9aea74b547d2d238c447ab89a9) (bool allRightsReserved) <a id="details" name="details"></a>## Detailed Description

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.

[CffBase](classansys_1_1_cff_base.xhtml "Base class that provides common function used by both CffConsumer and CffProvider classes.") cannot be instantiated itself but must be used via the derived classes [ansys::CffConsumer](classansys_1_1_cff_consumer.xhtml) (when writing to CFF) and [ansys::CffProvider](classansys_1_1_cff_provider.xhtml) (when reading from CFF).



## Member Enumeration Documentation

<a id="a1e830177b6b0f3a1ab06bd2679f8a801" name="a1e830177b6b0f3a1ab06bd2679f8a801"></a>## [◆ ](#a1e830177b6b0f3a1ab06bd2679f8a801)UpdateMethod

 enum class [ansys::CffBase::UpdateMethod](classansys_1_1_cff_base.xhtml#a1e830177b6b0f3a1ab06bd2679f8a801)  strongprotected 

Enumerator<a id="a1e830177b6b0f3a1ab06bd2679f8a801aa0021edb3bd3a0360dad3a09fe2c2185" name="a1e830177b6b0f3a1ab06bd2679f8a801aa0021edb3bd3a0360dad3a09fe2c2185"></a>CaseOnly <a id="a1e830177b6b0f3a1ab06bd2679f8a801ad0a948b0e19dfca30fe1b7fc8745cc52" name="a1e830177b6b0f3a1ab06bd2679f8a801ad0a948b0e19dfca30fe1b7fc8745cc52"></a>ResultsOnly <a id="a1e830177b6b0f3a1ab06bd2679f8a801a3e88061dedbcbe68f2a2b719a774044d" name="a1e830177b6b0f3a1ab06bd2679f8a801a3e88061dedbcbe68f2a2b719a774044d"></a>CaseAndResults 



## Constructor &amp; Destructor Documentation

<a id="a8e91a34b6ff2e403b674b5f7eabbd30d" name="a8e91a34b6ff2e403b674b5f7eabbd30d"></a>## [◆ ](#a8e91a34b6ff2e403b674b5f7eabbd30d)CffBase()

 ansys::CffBase::CffBase  ( ) 

Constructor.

A [CffBase](classansys_1_1_cff_base.xhtml "Base class that provides common function used by both CffConsumer and CffProvider classes.") object cannot be constructed directly but needs to be constructed by a create an object that has been derived from it.





<a id="a20caf165b9dd7454fc7792d61e14eb7e" name="a20caf165b9dd7454fc7792d61e14eb7e"></a>## [◆ ](#a20caf165b9dd7454fc7792d61e14eb7e)~CffBase()

 ansys::CffBase::~CffBase  ( )   virtual 

Destructor.

Destroys an instance of a type [CffBase](classansys_1_1_cff_base.xhtml "Base class that provides common function used by both CffConsumer and CffProvider classes.")





## Member Function Documentation

<a id="a2ec5c496eb4060808d5c93e7de48afba" name="a2ec5c496eb4060808d5c93e7de48afba"></a>## [◆ ](#a2ec5c496eb4060808d5c93e7de48afba)addSetting()

 bool ansys::CffBase::addSetting  ( const [DataClass](group__enums.xhtml#gab852cc24891eb831942fb8da764d8ddb)  *type*,    const std::string &amp;  *key*,    const std::string &amp;  *value*,    const [SolverType](group__typedefs.xhtml#ga195806ab92eb9a11e3bda91098c6ac38) &amp;  *solverType* = `"CFF_GENERIC"`   ) 

Sets a specific setting by supplying a key and a value.

Parameters type\[in\] - The class of data to which the setting applies key\[in\] - The key of the setting being set value\[in\] - The value to be associated with the key solverType\[in\] - The solver writing the data Returns- True if successully added, false otherwise 



<a id="ac3afd0039522c633e78e643ef5c92c88" name="ac3afd0039522c633e78e643ef5c92c88"></a>## [◆ ](#ac3afd0039522c633e78e643ef5c92c88)addSettingsDataSet()

 bool ansys::CffBase::addSettingsDataSet  ( const [DataClass](group__enums.xhtml#gab852cc24891eb831942fb8da764d8ddb)  *dataClass*,    const std::string &amp;  *dataSetPath*,    const std::string &amp;  *settings*,    const [SolverType](group__typedefs.xhtml#ga195806ab92eb9a11e3bda91098c6ac38) &amp;  *solverType* = `"CFF_GENERIC"`,    const std::vector&lt; std::string &gt; &amp;  *settingsKeys* = `std::vector<std::string>()`   ) 

Defines a set of data that contain the more than one setting.

A complete dataset containing multiple settings may be supplied to the interface that are typically in a solvers native language. When called this function parsers the settings uusing the parser appropriate for the solver type supplied, thus breaking the settings into key value pairs, and stores mattched subset of the settings controlled by settingsKeys.

A non-default parser may be supplied by the user calling [registerSettingsParser](classansys_1_1_cff_base.xhtml#a52f6b4e5a617b22028b2cab38fcbc861) prior to this function being called.

The settings will override any settings already stored in the dataset

Parameters dataClass\[in\] - The class of data to which the setting applies dataSetPath\[in\] - The data set in which to store the settings settings\[in\] - The settings to parse prior to storing in the dataset solverType\[in\] - The solver providing the settings data settingsKeys\[in\] - A set of keys that is used to restrict the settings to a subset key values. If empty all supplied settings are stored Returns- true if a valid parser is found, otherwise false 



<a id="a61b15533595d9c6fb16b083c1810f362" name="a61b15533595d9c6fb16b083c1810f362"></a>## [◆ ](#a61b15533595d9c6fb16b083c1810f362)addTimeLevel()

 void ansys::CffBase::addTimeLevel  ( [TimeLevelType](group__typedefs.xhtml#gabedb5244490da90f6098241bdc88e24c)  *timeLevel*)  const  protected 





<a id="a5a34019a24cdc2b0198f5fd1f9169579" name="a5a34019a24cdc2b0198f5fd1f9169579"></a>## [◆ ](#a5a34019a24cdc2b0198f5fd1f9169579)addVariableOfCategory()

 void ansys::CffBase::addVariableOfCategory  ( [VariableIdType](group__typedefs.xhtml#gae1bb05c41fbbd2e21c7b62cbe214b4be)  *varId*,    [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b)  *category*   )  const  protected 





<a id="a0b1de966137efffa6bd89ed3e26005b0" name="a0b1de966137efffa6bd89ed3e26005b0"></a>## [◆ ](#a0b1de966137efffa6bd89ed3e26005b0)finalizeMeshContext()

 virtual void ansys::CffBase::finalizeMeshContext  ( )   inlineprotectedvirtual 





<a id="ac71e552c0ad9f94ec0b117f544e16dab" name="ac71e552c0ad9f94ec0b117f544e16dab"></a>## [◆ ](#ac71e552c0ad9f94ec0b117f544e16dab)getActivePhase() \[1/2\]

 bool ansys::CffBase::getActivePhase  ( [PhaseIdType](group__typedefs.xhtml#gac3312714419db4aa206bdeda4efa9223) &amp;  *phaseId*)  const  protected 





<a id="afa627cbd51a548d5e9d7357ee0ff879d" name="afa627cbd51a548d5e9d7357ee0ff879d"></a>## [◆ ](#afa627cbd51a548d5e9d7357ee0ff879d)getActivePhase() \[2/2\]

 bool ansys::CffBase::getActivePhase  ( [PhaseName](group__typedefs.xhtml#gaec2c2963724097e7a913a6645b545682) &amp;  *phaseName*)  const  protected 





<a id="a3a07688c012e35b57939fe2a94ae7bf6" name="a3a07688c012e35b57939fe2a94ae7bf6"></a>## [◆ ](#a3a07688c012e35b57939fe2a94ae7bf6)getAllFaceZoneFlags()

 void ansys::CffBase::getAllFaceZoneFlags  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *faceZoneId*,    int &amp;  *allFlags*   )  const

Get flags for a face zone.

Flags are returned in an integer using a 'C' style bit pattern.

The application developer using the API is assumed to have full knowledge of the bitwise operations in the C programming language and should consider this when writing the flags associated with the face zone.

Please note this is a Fluent solver concept for coupled walls to handle baffles or solid zones. Where a zone/shadow zone pair is defined: The first bit is reserved for the major zone. The second bit is reserved for the minor zone. Only if the shadow face zones pair is a wall (i.e. Conjugate Heat Transfer (CHT) case), the third bit is used to indicate that each zone is in fact a wall.

Parameters faceZoneId\[in\] - The zone Id, from which the flag will be get allFlags\[out\] - The flags stored as a bit pattern 



<a id="a2c9e460ac858ffb8050c9e4c30c23eb9" name="a2c9e460ac858ffb8050c9e4c30c23eb9"></a>## [◆ ](#a2c9e460ac858ffb8050c9e4c30c23eb9)getApplicationName()

 std::string ansys::CffBase::getApplicationName  ( )  const  protected 

Obtains the application name that was set by calling [setApplicationName](classansys_1_1_cff_base.xhtml#a37ac2d23d1b21376117cb574ea5aecd5) logging when writing a file.

Returns- The application name 



<a id="aefdb444e036bf2bde4727ca122985a06" name="aefdb444e036bf2bde4727ca122985a06"></a>## [◆ ](#aefdb444e036bf2bde4727ca122985a06)getCellFaceZoneIds()

 void ansys::CffBase::getCellFaceZoneIds  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *cellZoneId*,    std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &amp;  *zoneIds*   ) 

Get a list of face zones touching a cell zone.

Parameters cellZoneId- cell zone ID to get the face zones for zoneIds- list of face zones IDs 



<a id="a8cdb470e83dfbe98fda9597e5908570d" name="a8cdb470e83dfbe98fda9597e5908570d"></a>## [◆ ](#a8cdb470e83dfbe98fda9597e5908570d)getCellZoneInfo()

 void ansys::CffBase::getCellZoneInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *cellZoneId*,    const [CellZoneInfoType](group__enums.xhtml#gaaffda1f82c7b51d603aff684c9ab0cd2)  *cellZoneInfoType*,    int &amp;  *info*   )  const

get certain zone level info for a cell zone.

Parameters cellZoneId\[in\] - The zone Id, of which the zone info will be get cellZoneInfoType\[in\] - The zone info type to get, refer [CffCellZoneInfoType](group__enums.xhtml#gaaffda1f82c7b51d603aff684c9ab0cd2 "An enumerated type that used when querying or setting information that is specific to a cell zones us...") for all cell zone info types info\[out\] - The actual data for the zone info type 



<a id="a781704a9b5db32ad76674f0d76ff1c82" name="a781704a9b5db32ad76674f0d76ff1c82"></a>## [◆ ](#a781704a9b5db32ad76674f0d76ff1c82)getEdgeZoneInfo()

 void ansys::CffBase::getEdgeZoneInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *edgeZoneId*,    const [EdgeZoneInfoType](group__enums.xhtml#gab5510fa8ae80e1c0e3f4d17207ac2cf8)  *edgeZoneInfoType*,    int &amp;  *info*   )  const

get certain zone level info for a edge zone.

Parameters edgeZoneId\[in\] - The zone Id, of which the zone info will be get edgeZoneInfoType\[in\] - The zone info type to get, refer [CffEdgeZoneInfoType](group__enums.xhtml#gab5510fa8ae80e1c0e3f4d17207ac2cf8 "An enumerated type that used when querying or setting information that is specific to a edge zones us...") for all edge zone info types info\[out\] - The actual data for the zone info type 



<a id="a338831ea194619a576aa15aa96f479f8" name="a338831ea194619a576aa15aa96f479f8"></a>## [◆ ](#a338831ea194619a576aa15aa96f479f8)getEdgeZoneType()

 void ansys::CffBase::getEdgeZoneType  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *edgeZoneId*,    [EdgeZoneType](group__enums.xhtml#gac0bfa43991cd91c6cc7045a2596e36bf) &amp;  *zoneType*   )  const

get the zone type of a edge zone.

Zone types of edges zones indicate edge type of the edge zone. For all defined edge zone types, see [CffEdgeZoneType](group__enums.xhtml#gac0bfa43991cd91c6cc7045a2596e36bf "An enumerated type representing the type of an edge zone which may be returned from the function ansy...")

Parameters edgeZoneId\[in\] - The zone Id, of which the zone type will be get zoneType\[out\] - The edge zone type 



<a id="a4ad1f2f007e8a575da4935bbc136ee1a" name="a4ad1f2f007e8a575da4935bbc136ee1a"></a>## [◆ ](#a4ad1f2f007e8a575da4935bbc136ee1a)getErrors()

 std::vector&lt; std::string &gt; ansys::CffBase::getErrors  ( bool  *formatted* = `true`,    bool  *clear* = `false`   )  const

returns, as strings, any unprocessed error messages registered

Parameters \[in\]formatted- true if the message should be returned in a format that includes its type. \[in\]clear- clear errors on return Returns- vector of messages 



<a id="aed5f714fd202db49f2d5dbc643f8ae0b" name="aed5f714fd202db49f2d5dbc643f8ae0b"></a>## [◆ ](#aed5f714fd202db49f2d5dbc643f8ae0b)getFaceCellZone0Ids() \[1/2\]

 void ansys::CffBase::getFaceCellZone0Ids  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *faceZoneId*,    std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &amp;  *zoneIds*   ) 

Get a list of cell zones on side zero of a face zone.

Parameters faceZoneId- face zone ID to get the cell0 for zoneIds- list of cell0 zones IDs 



<a id="acb322a7e2667baee3ae555968a4bb429" name="acb322a7e2667baee3ae555968a4bb429"></a>## [◆ ](#acb322a7e2667baee3ae555968a4bb429)getFaceCellZone0Ids() \[2/2\]

 void ansys::CffBase::getFaceCellZone0Ids  ( std::map&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96), std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;  )   protected 





<a id="a5b3ac69ef66941dc47ac51567da0e811" name="a5b3ac69ef66941dc47ac51567da0e811"></a>## [◆ ](#a5b3ac69ef66941dc47ac51567da0e811)getFaceCellZone1Ids() \[1/2\]

 void ansys::CffBase::getFaceCellZone1Ids  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *faceZoneId*,    std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &amp;  *zoneIds*   ) 

Get a list of cell zones on side one of a face zone.

Parameters faceZoneId- face zone ID to get the cell1 for zoneIds- list of cell1 zones IDs 



<a id="ad4fedb6f7158c5340fcc0dd5ebffa790" name="ad4fedb6f7158c5340fcc0dd5ebffa790"></a>## [◆ ](#ad4fedb6f7158c5340fcc0dd5ebffa790)getFaceCellZone1Ids() \[2/2\]

 void ansys::CffBase::getFaceCellZone1Ids  ( std::map&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96), std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;  )   protected 





<a id="af7d98ff434df5ca813e0abc6fcda06b5" name="af7d98ff434df5ca813e0abc6fcda06b5"></a>## [◆ ](#af7d98ff434df5ca813e0abc6fcda06b5)getFaceZoneInfo()

 void ansys::CffBase::getFaceZoneInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *faceZoneId*,    const [FaceZoneInfoType](group__enums.xhtml#ga90bd9c961be9a1b7e7d014e9f04588e3)  *faceZoneInfoType*,    int &amp;  *info*   )  const

get certain zone level info for a face zone.

Parameters faceZoneId\[in\] - The zone Id, of which the zone info will be get faceZoneInfoType\[in\] - The zone info type to get, refer [CffFaceZoneInfoType](group__enums.xhtml#ga90bd9c961be9a1b7e7d014e9f04588e3 "An enumerated type that used when querying or setting information that is specific to a face zones us...") for all face zone info types info\[in\] - The actual data for the zone info type 



<a id="a6916863ecd01e1a7f61660c64cf64b85" name="a6916863ecd01e1a7f61660c64cf64b85"></a>## [◆ ](#a6916863ecd01e1a7f61660c64cf64b85)getFaceZoneProp()

 bool ansys::CffBase::getFaceZoneProp  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *faceZoneId*,    const [FaceZonePropType](group__enums.xhtml#gadf13e7806827f3d0db8ecb550aa50384)  *faceZonePropType*   )  const





<a id="a54f28797f4937e10436099ce2aeacfb9" name="a54f28797f4937e10436099ce2aeacfb9"></a>## [◆ ](#a54f28797f4937e10436099ce2aeacfb9)getFaceZoneType()

 void ansys::CffBase::getFaceZoneType  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *faceZoneId*,    [FaceZoneType](group__enums.xhtml#ga13c2dd97c5e14c90a074a2c603ec2bc3) &amp;  *zoneType*   )  const

get the zone type of a face zone.

Zone types of edges zones indicate face element type of the face zone. For all defined face zone types, see [CffFaceZoneType](group__enums.xhtml#ga13c2dd97c5e14c90a074a2c603ec2bc3 "An enumerated type representing the boundary type of a face zone which may be returned from the funct...")

Parameters faceZoneId\[in\] - The zone Id, of which the zone type will be get zoneType\[out\] - The face zone type 



<a id="af0d21caac7777b939f76735e83984cbe" name="af0d21caac7777b939f76735e83984cbe"></a>## [◆ ](#af0d21caac7777b939f76735e83984cbe)getGroupNameForPhase()

 std::string ansys::CffBase::getGroupNameForPhase  ( [PhaseIdType](group__typedefs.xhtml#gac3312714419db4aa206bdeda4efa9223)  *phaseId*)  const  protected 





<a id="a082d2c3d4dc0c44c918764d25adcadda" name="a082d2c3d4dc0c44c918764d25adcadda"></a>## [◆ ](#a082d2c3d4dc0c44c918764d25adcadda)getInfos()

 std::vector&lt; std::string &gt; ansys::CffBase::getInfos  ( bool  *formatted* = `true`,    bool  *clear* = `false`   )  const

returns, as strings, any unprocessed information messages registered

Parameters \[in\]formatted- true if the message should be returned in a format that includes its type. \[in\]clear- clear informtion messages on return Returns- vector of messages 



<a id="a6ef0a23c0b31c58b1a70e8c7abdb3cb9" name="a6ef0a23c0b31c58b1a70e8c7abdb3cb9"></a>## [◆ ](#a6ef0a23c0b31c58b1a70e8c7abdb3cb9)getLocationModel()

 const [CffLocationModel](classansys_1_1_cff_location_model.xhtml) \* ansys::CffBase::getLocationModel  ( )  const

Get a query interface to the underlying topology model.





<a id="a38bd51885eca5de0f72d49db6bff1ffb" name="a38bd51885eca5de0f72d49db6bff1ffb"></a>## [◆ ](#a38bd51885eca5de0f72d49db6bff1ffb)getMeshId()

 [MeshIdType](group__typedefs.xhtml#ga9a6c5565b81f965277b48f14355a38ae) ansys::CffBase::getMeshId  ( )  const

Get the Identifier of the active mesh.

ReturnsThe Id of the active mesh 



<a id="acaf3eef987d98a7af34c15b9b7954abc" name="acaf3eef987d98a7af34c15b9b7954abc"></a>## [◆ ](#acaf3eef987d98a7af34c15b9b7954abc)getMeshSize()

 void ansys::CffBase::getMeshSize  ( const [MeshSizeType](group__enums.xhtml#gaf5d669ab21b6699ea497958b17c32002)  *type*,    [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107) &amp;  *size*   )  const

Obtains a value that defines the dimension or the global number of objects of a specific mesh entity.

Parameters type\[in\] - Type of mesh size for which the value is to be obtained. size\[out\] - The value for the type of mesh sizing requested. 



<a id="a1f85337345d893d33c9cfcdd0431757a" name="a1f85337345d893d33c9cfcdd0431757a"></a>## [◆ ](#a1f85337345d893d33c9cfcdd0431757a)getMeshUnits()

 void ansys::CffBase::getMeshUnits  ( std::string &amp;  *units*)  const

Obtains the unit of length the mesh is defined in.

By default the units are in the SI unit of length "m"

Parameters units\[out\] - The unit the mesh is defined in. 



<a id="ab3cf0c9c550daa3233c0121c06b9a12e" name="ab3cf0c9c550daa3233c0121c06b9a12e"></a>## [◆ ](#ab3cf0c9c550daa3233c0121c06b9a12e)getMessageRegistrar()

 CffMessageRegistrar \* ansys::CffBase::getMessageRegistrar  ( )  const

Obtains a message registrar object so that external plug-ins can register messages with the API.

Returns- A pointer to the message registration object.Note: The registrar remains in the ownership of the API and should not be destroyed





<a id="a5a38fe3bcf5c8c129c6691b5c57440e9" name="a5a38fe3bcf5c8c129c6691b5c57440e9"></a>## [◆ ](#a5a38fe3bcf5c8c129c6691b5c57440e9)getNodeZoneInfo()

 void ansys::CffBase::getNodeZoneInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *nodeZoneId*,    const [NodeZoneInfoType](group__enums.xhtml#gacc3f469fa6326c4b75b40d9e4f8313db)  *nodeZoneInfoType*,    int &amp;  *info*   )  const

get certain zone level info for a node zone.

Parameters nodeZoneId\[in\] - The zone Id, of which the zone info will be get nodeZoneInfoType\[in\] - The zone info type to get, refer [CffNodeZoneInfoType](group__enums.xhtml#gacc3f469fa6326c4b75b40d9e4f8313db "An enumerated type that used when querying or setting information that is specific to a node zones us...") for all node zone info types info\[out\] - The actual data for the zone info type 



<a id="a3cfe9f0e37df52d9d9a0d0846f01be44" name="a3cfe9f0e37df52d9d9a0d0846f01be44"></a>## [◆ ](#a3cfe9f0e37df52d9d9a0d0846f01be44)getNumZones()

 size\_t ansys::CffBase::getNumZones  ( const [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b)  *zoneCategory*)  const  virtual 

Returns the number of zones in a specific category.

Parameters zoneCategory\[in\] - The category to query. Returns- The number of zones defined of that category. 



<a id="aebfbe683df8687fd15685c7cf5e2dbe9" name="aebfbe683df8687fd15685c7cf5e2dbe9"></a>## [◆ ](#aebfbe683df8687fd15685c7cf5e2dbe9)getPartitionId()

 [PartitionIdType](group__typedefs.xhtml#gaa0b01fb68d68067022164a7fcb5cb0e5) ansys::CffBase::getPartitionId  ( )  const





<a id="af555905619187578ebedc0da9116ae54" name="af555905619187578ebedc0da9116ae54"></a>## [◆ ](#af555905619187578ebedc0da9116ae54)getPhaseIds()

 void ansys::CffBase::getPhaseIds  ( [PhaseIds](group__typedefs.xhtml#ga99ff3bf3b76eac538df4d637faab6b4c) &amp;  *phaseIds*)  const

Obtain the Identifiers of all Phase.

Parameters phaseIds\[out\] - The Identifiers of all Phases. 



<a id="aaf2782a59cd4e5939299c278f2e2c14d" name="aaf2782a59cd4e5939299c278f2e2c14d"></a>## [◆ ](#aaf2782a59cd4e5939299c278f2e2c14d)getPhaseName() \[1/2\]

 [PhaseName](group__typedefs.xhtml#gaec2c2963724097e7a913a6645b545682) ansys::CffBase::getPhaseName  ( const [PhaseIdType](group__typedefs.xhtml#gac3312714419db4aa206bdeda4efa9223)  *phaseId*)  const

Obtain the unique name a specific Phase.

This function is deprecated in favour of [getPhaseName(const PhaseIdType, PhaseName&amp;) const](classansys_1_1_cff_base.xhtml#ac0e318ff4148977296fd1e7e332a4cb2 "Obtain the unique name a specific Phase.")

Parameters phaseId\[in\] - The Phase Identifier for which to obtain the name. Returns- The unique name obtained. 



<a id="ac0e318ff4148977296fd1e7e332a4cb2" name="ac0e318ff4148977296fd1e7e332a4cb2"></a>## [◆ ](#ac0e318ff4148977296fd1e7e332a4cb2)getPhaseName() \[2/2\]

 bool ansys::CffBase::getPhaseName  ( const [PhaseIdType](group__typedefs.xhtml#gac3312714419db4aa206bdeda4efa9223)  *phaseId*,    [PhaseName](group__typedefs.xhtml#gaec2c2963724097e7a913a6645b545682) &amp;  *phaseName*   )  const

Obtain the unique name a specific Phase.

Parameters phaseId\[in\] - The Phase Identifier for which to obtain the name. phaseName\[out\] - The unique name obtained. Returns- Whether the Phase supplied was valid. 



<a id="aac055e13c1b7040833aa2d981a606486" name="aac055e13c1b7040833aa2d981a606486"></a>## [◆ ](#aac055e13c1b7040833aa2d981a606486)getSolverType()

 [SolverType](group__typedefs.xhtml#ga195806ab92eb9a11e3bda91098c6ac38) ansys::CffBase::getSolverType  ( )  const

Obtains the owner of the data in the model.

Returns- The name of the application that supplied the data. 



<a id="acd55506ab391dd7dd7e62f51f7aaa2b0" name="acd55506ab391dd7dd7e62f51f7aaa2b0"></a>## [◆ ](#acd55506ab391dd7dd7e62f51f7aaa2b0)getSortedMinIdZoneId()

 void ansys::CffBase::getSortedMinIdZoneId  ( const [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b)  *zoneCategory*,    std::vector&lt; std::pair&lt; [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107), [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;  *minIdZoneId*   )  const  protected 





<a id="a9ed7e905d291697c22f073ee8482ec40" name="a9ed7e905d291697c22f073ee8482ec40"></a>## [◆ ](#a9ed7e905d291697c22f073ee8482ec40)getTarget()

 [TargetCategory](group__enums.xhtml#ga2bf8717ca5a1d17190dddf5faf6efa5d) ansys::CffBase::getTarget  ( )  const

Get the target category for which the data is intended.

The target category defines whether the mesh and solution data is written as a CFF Solver Restart data or a CFF Post Processing file.

Typically for some applications, such as ANSYS Fluent, restart data may not be used for Post processing without careful understanding of how the restart data has been written.

Returns- The category of data being processed.   




<a id="acd2f82d0cc8278ce20a870e5216dc16b" name="acd2f82d0cc8278ce20a870e5216dc16b"></a>## [◆ ](#acd2f82d0cc8278ce20a870e5216dc16b)getTimeLevel()

 [TimeLevelType](group__typedefs.xhtml#gabedb5244490da90f6098241bdc88e24c) ansys::CffBase::getTimeLevel  ( )  const

Get the current time level that is being read or written to the results data





<a id="aed5e5b99ed3a9c2f0c99c79f766529f6" name="aed5e5b99ed3a9c2f0c99c79f766529f6"></a>## [◆ ](#aed5e5b99ed3a9c2f0c99c79f766529f6)getTimeLevels()

 const [TimeLevels](group__typedefs.xhtml#ga05f2423bfbdc98936c0b6e77108a3ceb) &amp; ansys::CffBase::getTimeLevels  ( )  const

Get the time levels that have been read/written to the results data





<a id="ac9b6a55b76b04124c6e0ce8670b27cdf" name="ac9b6a55b76b04124c6e0ce8670b27cdf"></a>## [◆ ](#ac9b6a55b76b04124c6e0ce8670b27cdf)getWarnings()

 std::vector&lt; std::string &gt; ansys::CffBase::getWarnings  ( bool  *formatted* = `true`,    bool  *clear* = `false`   )  const

returns, as strings, any unprocessed warning messages registered

Parameters \[in\]formatted- true if the message should be returned in a format that includes its type. \[in\]clear- clear warnings on return Returns- vector of messages 



<a id="aefc5f51cf7ed4b2d2f7c887e28edb068" name="aefc5f51cf7ed4b2d2f7c887e28edb068"></a>## [◆ ](#aefc5f51cf7ed4b2d2f7c887e28edb068)getZoneCategory()

 [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b) ansys::CffBase::getZoneCategory  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *zoneId*)  const  protected 

get the zone category of a given zone by zone id

Parameters zoneId\[in\] - the zone id, of which zone, the zone category will be retrieved Returns- zone category of all the zones indicated by the input argument, all supported zone categories are defined in [ZoneCategory](group__typedefs.xhtml#ga3cc9d15e024ad6722eb61bb422097ba5 "Alias for CffZoneCategory ('C++' API only)") 



<a id="a27eedb8c5bce9f6df83472ad4f3e02bd" name="a27eedb8c5bce9f6df83472ad4f3e02bd"></a>## [◆ ](#a27eedb8c5bce9f6df83472ad4f3e02bd)getZoneIds()

 void ansys::CffBase::getZoneIds  ( const [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b)  *zoneCategory*,    [ZoneIds](group__typedefs.xhtml#ga93b257990d79f628e301fb5e39125cfa) &amp;  *zoneIds*   )  const  virtual 

Request the collection of zone Ids that are of a specific category.

Parameters zoneCategory\[in\] - The category too query. zoneIds\[out\] - The zone Ids in the category.Note: zoneIds is correctly sized by the function.





<a id="a3288b67c94eebe85133afbf5c6329a73" name="a3288b67c94eebe85133afbf5c6329a73"></a>## [◆ ](#a3288b67c94eebe85133afbf5c6329a73)getZoneSizeInfo()

 void ansys::CffBase::getZoneSizeInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *zoneId*,    const [ZoneSizeType](group__enums.xhtml#ga54ba682a6deedd60cb203d1963a0ac12)  *sizeType*,    [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107) &amp;  *size*   )  const

Obtains a size setting of a zone.

Zones are defined with a dimension, number of objects, and the object Id range (start Id and end Id). This function allows the user to obtain the value of each individual size setting independently. The type of setting is defined by an enum [ZoneSizeType](group__typedefs.xhtml#ga596f56359ce823cc5274c3a7626a485a).

Parameters zoneId\[in\] - The id of the zone for which the value is being set. sizeType\[in\] - The setting being defined. e.g. CFF\_ZONE\_DIMENSION size\[out\] - The value associated with the zone or 0 if in error. 



<a id="a996240e5d9daecbd1a2fca41931e6857" name="a996240e5d9daecbd1a2fca41931e6857"></a>## [◆ ](#a996240e5d9daecbd1a2fca41931e6857)getZoneStringInfo()

 void ansys::CffBase::getZoneStringInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *zoneId*,    const [ZoneStringInfoType](group__enums.xhtml#ga7fe67117cb23bbcbb4ff2d5b55c3a704)  *type*,    std::string &amp;  *info*   )  const

Obtains a string value associated with a zone.

Typically a mesh zone will have a name that identifies it, it may also have a type represented as a string.

To obtaint the appropriate value [ZoneStringInfoType](group__typedefs.xhtml#ga302285ede15d899051c0478f5b8190d6) is passed to the function to indicate the type of setting being requested.

Parameters zoneId\[in\] - The Zone Id for which information is to be obtained. type\[in\] - The Type of string setting being obtained. info\[out\] - The value of the setting. 



<a id="ae21605b67de8dfdc99ed2dd2436c8276" name="ae21605b67de8dfdc99ed2dd2436c8276"></a>## [◆ ](#ae21605b67de8dfdc99ed2dd2436c8276)hasError()

 bool ansys::CffBase::hasError  ( )  const

returns whether there are unprocessed error messages registered.

Returns- true if messages are unprocessed, false otherwise 



<a id="a9951a635748839427d6f0025ffe52624" name="a9951a635748839427d6f0025ffe52624"></a>## [◆ ](#a9951a635748839427d6f0025ffe52624)hasInfo()

 bool ansys::CffBase::hasInfo  ( )  const

returns whether there are unprocessed informative messages registered.

Returns- true if messages are unprocessed, false otherwise 



<a id="a0c21e26398dc9974f47ca3483ddf5511" name="a0c21e26398dc9974f47ca3483ddf5511"></a>## [◆ ](#a0c21e26398dc9974f47ca3483ddf5511)hasWarning()

 bool ansys::CffBase::hasWarning  ( )  const

returns whether there are unprocessed warning messages registered.

Returns- true if messages are unprocessed, false otherwise 



<a id="a2630b322188a07ec1eeb9b136c73c4e2" name="a2630b322188a07ec1eeb9b136c73c4e2"></a>## [◆ ](#a2630b322188a07ec1eeb9b136c73c4e2)initializeVariableAttributeProvider()

 void ansys::CffBase::initializeVariableAttributeProvider  ( const [SolverType](group__typedefs.xhtml#ga195806ab92eb9a11e3bda91098c6ac38) &amp;  *solverType*,    const std::string &amp;  *variableTarget*   )   protected 





<a id="a624faedd25141cbf3f46877cfa7a2c53" name="a624faedd25141cbf3f46877cfa7a2c53"></a>## [◆ ](#a624faedd25141cbf3f46877cfa7a2c53)initLocationModel()

 virtual void ansys::CffBase::initLocationModel  ( )  const  inlineprotectedvirtual 





<a id="a0f6a86dc4029c4ff72ccf893a1247fb1" name="a0f6a86dc4029c4ff72ccf893a1247fb1"></a>## [◆ ](#a0f6a86dc4029c4ff72ccf893a1247fb1)isSupported()

 [CffReadable](group__enums.xhtml#ga0fb9773918c961ce8187a074481c3069) ansys::CffBase::isSupported  ( const std::string &amp;  *version*)  const  protected 

Check whether the version can be read by this version of the CFF SDK.

Parameters version\[in\] - The version number string representing the data being processed. Returns- CFF\_READABLE\_OK if the API can read the data, CFF\_READABLE\_WARN if the data can be read partially or with warnings, CFF\_READABLE\_ERROR if the data is incompatible with this version of the API. 



<a id="a022d5e7d262d2f307d305b071844f7b8" name="a022d5e7d262d2f307d305b071844f7b8"></a>## [◆ ](#a022d5e7d262d2f307d305b071844f7b8)locationModel()

 [CffLocationModel](classansys_1_1_cff_location_model.xhtml) \* ansys::CffBase::locationModel  ( )  const  protected 





<a id="a52f6b4e5a617b22028b2cab38fcbc861" name="a52f6b4e5a617b22028b2cab38fcbc861"></a>## [◆ ](#a52f6b4e5a617b22028b2cab38fcbc861)registerSettingsParser()

 void ansys::CffBase::registerSettingsParser  ( CffSettingsParser \*  *parser*) 

Sets a parser for processing settings.

Settings are typically stored within a CFF file as a set of strings in order to provide common access to these settings a settings parser may be provided as an alternative to those installed by default that read the strings, manipulate the settings and return them in a form that is common across all applications.

It is unlikley that a user will need to supply an alternative parser

Parameters parser\[in\] - The parser to install. 



<a id="ae45bcd4e2a15aa09114e4f9767ce7b6a" name="ae45bcd4e2a15aa09114e4f9767ce7b6a"></a>## [◆ ](#ae45bcd4e2a15aa09114e4f9767ce7b6a)setActivePhase() \[1/2\]

 bool ansys::CffBase::setActivePhase  ( const [PhaseName](group__typedefs.xhtml#gaec2c2963724097e7a913a6645b545682) &amp;  *phaseName*)  const  protected 





<a id="ab033b5affde5ab8b4ae0ff2bc27a1c57" name="ab033b5affde5ab8b4ae0ff2bc27a1c57"></a>## [◆ ](#ab033b5affde5ab8b4ae0ff2bc27a1c57)setActivePhase() \[2/2\]

 bool ansys::CffBase::setActivePhase  ( [PhaseIdType](group__typedefs.xhtml#gac3312714419db4aa206bdeda4efa9223)  *phaseId*)  const  protected 





<a id="abb3c12f95d090dd9df153008b6515ed7" name="abb3c12f95d090dd9df153008b6515ed7"></a>## [◆ ](#abb3c12f95d090dd9df153008b6515ed7)setAllFaceZoneFlags()

 void ansys::CffBase::setAllFaceZoneFlags  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *faceZoneId*,    const int  *allFlags*   ) 

Set flags for a face zone.

Flags are supplied in an integer using a 'C' style bit pattern.

The application developer using the API is assumed to have full knowledge of the bitwise operations in the C programming language and should consider this when writing the flags associated with the face zone.

Please note this is a Fluent solver concept for coupled walls to handle baffles or solid zones. Where a zone/shadow zone pair is defined: The first bit is reserved for the major zone. The second bit is reserved for the minor zone. Only if the shadow face zones pair is a wall (i.e. Conjugate Heat Transfer (CHT) case), the third bit is used to indicate that each zone is in fact a wall.

Parameters faceZoneId\[in\] - The Id of the zone, for which the flags will be set allFlags\[in\] - The flags stored as a bit pattern 



<a id="a37ac2d23d1b21376117cb574ea5aecd5" name="a37ac2d23d1b21376117cb574ea5aecd5"></a>## [◆ ](#a37ac2d23d1b21376117cb574ea5aecd5)setApplicationName()

 void ansys::CffBase::setApplicationName  ( const std::string &amp;  *applicationName*) 

Sets an application name for error purposes and when logging to a file.

Parameters applicationName\[in\] - The application name to set 



<a id="a5f0ef9af551d0fa910224bcd5b2ff012" name="a5f0ef9af551d0fa910224bcd5b2ff012"></a>## [◆ ](#a5f0ef9af551d0fa910224bcd5b2ff012)setCellFaceZoneIds()

 void ansys::CffBase::setCellFaceZoneIds  ( const std::map&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96), std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;  *cfz*)   protected 

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.

Parameters cfz\[in\] - A std map, for each entity in the map, the key is the cell zone id, the value is a list, whose elements are face zone ids of the corresponding cell zone 



<a id="a4fad271e6ee24cc9de5fca8e0990e558" name="a4fad271e6ee24cc9de5fca8e0990e558"></a>## [◆ ](#a4fad271e6ee24cc9de5fca8e0990e558)setCellZoneInfo()

 void ansys::CffBase::setCellZoneInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *cellZoneId*,    const [CellZoneInfoType](group__enums.xhtml#gaaffda1f82c7b51d603aff684c9ab0cd2)  *cellZoneInfoType*,    const int  *info*   ) 

set certain zone level info for a cell zone.

Parameters cellZoneId\[in\] - The zone Id, of which the zone info will be set cellZoneInfoType\[in\] - The zone info type to set, refer [CffCellZoneInfoType](group__enums.xhtml#gaaffda1f82c7b51d603aff684c9ab0cd2 "An enumerated type that used when querying or setting information that is specific to a cell zones us...") for all cell zone info types info\[in\] - The actual data for the zone info type 



<a id="a762f990aefce5b11164a58d2721bd350" name="a762f990aefce5b11164a58d2721bd350"></a>## [◆ ](#a762f990aefce5b11164a58d2721bd350)setDebugOn()

 void ansys::CffBase::setDebugOn  ( bool  *debug*)   virtual 

Turn on/off debugging information.

Parameters debug\[in\] - If true debugging is turned on, otherwise turned off 



<a id="a4deb6b8c569d92acabf1c0bd85a4f35f" name="a4deb6b8c569d92acabf1c0bd85a4f35f"></a>## [◆ ](#a4deb6b8c569d92acabf1c0bd85a4f35f)setEdgeZoneInfo()

 void ansys::CffBase::setEdgeZoneInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *edgeZoneId*,    const [EdgeZoneInfoType](group__enums.xhtml#gab5510fa8ae80e1c0e3f4d17207ac2cf8)  *edgeZoneInfoType*,    const int  *info*   ) 

set certain zone level info for a edge zone.

Parameters edgeZoneId\[in\] - The zone Id, of which the zone info will be set edgeZoneInfoType\[in\] - The zone info type to set, refer [CffEdgeZoneInfoType](group__enums.xhtml#gab5510fa8ae80e1c0e3f4d17207ac2cf8 "An enumerated type that used when querying or setting information that is specific to a edge zones us...") for all edge zone info types info\[in\] - The actual data for the zone info type 



<a id="a022ca55715eb4c7a1f46e7c1c7c899f3" name="a022ca55715eb4c7a1f46e7c1c7c899f3"></a>## [◆ ](#a022ca55715eb4c7a1f46e7c1c7c899f3)setEdgeZoneType()

 void ansys::CffBase::setEdgeZoneType  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *edgeZoneId*,    const [EdgeZoneType](group__enums.xhtml#gac0bfa43991cd91c6cc7045a2596e36bf)  *zoneType*   ) 

set zone type of a edge zone.

Zone types of edges zones indicate edge type of the edge zone. For all defined edge zone types, see [CffEdgeZoneType](group__enums.xhtml#gac0bfa43991cd91c6cc7045a2596e36bf "An enumerated type representing the type of an edge zone which may be returned from the function ansy...")

Parameters edgeZoneId\[in\] - The zone Id, to which the zone type will be set zoneType\[in\] - The edge zone type 



<a id="ac0abea2487c710f7091853e6519493e7" name="ac0abea2487c710f7091853e6519493e7"></a>## [◆ ](#ac0abea2487c710f7091853e6519493e7)setFaceCellZone0Ids()

 void ansys::CffBase::setFaceCellZone0Ids  ( const std::map&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96), std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;  *fc0*)   protected 

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.

Parameters fc0\[in\] - A std map, for each entity in the map, the key is the face zone id, the value is a list, whose elements are c0 cell zone ids of the corresponding face zone 



<a id="a5b3584e853403d6f0fdac43573c60fb0" name="a5b3584e853403d6f0fdac43573c60fb0"></a>## [◆ ](#a5b3584e853403d6f0fdac43573c60fb0)setFaceCellZone1Ids()

 void ansys::CffBase::setFaceCellZone1Ids  ( const std::map&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96), std::list&lt; [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96) &gt; &gt; &amp;  *fc1*)   protected 

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.

Parameters fc1\[in\] - A std map, for each entity in the map, the key is the face zone id, the value is a list, whose elements are c1 cell zone ids of the corresponding face zone 



<a id="a5c7a587b4206497cf6b9608c41d6b543" name="a5c7a587b4206497cf6b9608c41d6b543"></a>## [◆ ](#a5c7a587b4206497cf6b9608c41d6b543)setFaceZoneInfo()

 void ansys::CffBase::setFaceZoneInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *faceZoneId*,    const [FaceZoneInfoType](group__enums.xhtml#ga90bd9c961be9a1b7e7d014e9f04588e3)  *faceZoneInfoType*,    const int  *info*   )  const

set certain zone level info for a face zone.

Parameters faceZoneId\[in\] - The zone Id, of which the zone info will be set faceZoneInfoType\[in\] - The zone info type to set, refer [CffFaceZoneInfoType](group__enums.xhtml#ga90bd9c961be9a1b7e7d014e9f04588e3 "An enumerated type that used when querying or setting information that is specific to a face zones us...") for all face zone info types info\[in\] - The actual data for the zone info type 



<a id="a9fd0b6d7cec6f6bf0d1d49be26f7d55d" name="a9fd0b6d7cec6f6bf0d1d49be26f7d55d"></a>## [◆ ](#a9fd0b6d7cec6f6bf0d1d49be26f7d55d)setFaceZoneProp()

 void ansys::CffBase::setFaceZoneProp  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *faceZoneId*,    const [FaceZonePropType](group__enums.xhtml#gadf13e7806827f3d0db8ecb550aa50384)  *faceZonePropType*   ) 





<a id="a95e9e01481576f3f34c3b2276215fab7" name="a95e9e01481576f3f34c3b2276215fab7"></a>## [◆ ](#a95e9e01481576f3f34c3b2276215fab7)setFaceZoneType()

 void ansys::CffBase::setFaceZoneType  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *faceZoneId*,    const [FaceZoneType](group__enums.xhtml#ga13c2dd97c5e14c90a074a2c603ec2bc3)  *zoneType*   ) 

set zone type of a face zone.

Zone types of edges zones indicate face element type of the face zone. For all defined face zone types, see [CffFaceZoneType](group__enums.xhtml#ga13c2dd97c5e14c90a074a2c603ec2bc3 "An enumerated type representing the boundary type of a face zone which may be returned from the funct...")

Parameters faceZoneId\[in\] - The zone Id, to which the zone type will be set zoneType\[in\] - The face zone type 



<a id="aa91c9abb97b43c30e006c41852a54486" name="aa91c9abb97b43c30e006c41852a54486"></a>## [◆ ](#aa91c9abb97b43c30e006c41852a54486)setMeshContext()

 bool ansys::CffBase::setMeshContext  ( [MeshId](namespaceansys.xhtml#ad39fb97de8d4c01dcde3d4d829eee232)  *meshId*,    [TargetCategory](group__enums.xhtml#ga2bf8717ca5a1d17190dddf5faf6efa5d)  *target*,    [PartitionIdType](group__typedefs.xhtml#gaa0b01fb68d68067022164a7fcb5cb0e5)  *partition*,    [UpdateMethod](classansys_1_1_cff_base.xhtml#a1e830177b6b0f3a1ab06bd2679f8a801)  *method* = `<a class="el" href="classansys_1_1_cff_base.xhtml#a1e830177b6b0f3a1ab06bd2679f8a801a3e88061dedbcbe68f2a2b719a774044d">UpdateMethod::CaseAndResults</a>`   )   protected 





<a id="a7a12ef6589a193f80be541291b0cec4b" name="a7a12ef6589a193f80be541291b0cec4b"></a>## [◆ ](#a7a12ef6589a193f80be541291b0cec4b)setMeshId()

 void ansys::CffBase::setMeshId  ( const [MeshIdType](group__typedefs.xhtml#ga9a6c5565b81f965277b48f14355a38ae)  *meshId*) 

Set the Identifier for active mesh being read or written.

Parameters meshId\[in\] - The Id of the mesh 



<a id="a5c0728f170c875374eef517fcb4a75fb" name="a5c0728f170c875374eef517fcb4a75fb"></a>## [◆ ](#a5c0728f170c875374eef517fcb4a75fb)setMeshSize() \[1/2\]

 void ansys::CffBase::setMeshSize  ( const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107)  *nDims*,    const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107)  *nodesCount*,    const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107)  *edgesCount*,    const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107)  *facesCount*,    const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107)  *cellsCount*   )   protected 

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.

Parameters nDims\[in\] - the dimension of mesh, if the mesh is 3D, then nDims should be 3 nodesCount\[in\] - total number of nodes edgesCount\[in\] - total number of edges, facesCount\[in\] - total number of faces cellsCount\[in\] - total number of cells 



<a id="a259b65322ef0d42859d988166eed23d7" name="a259b65322ef0d42859d988166eed23d7"></a>## [◆ ](#a259b65322ef0d42859d988166eed23d7)setMeshSize() \[2/2\]

 void ansys::CffBase::setMeshSize  ( const [MeshSizeType](group__enums.xhtml#gaf5d669ab21b6699ea497958b17c32002)  *type*,    const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107)  *size*   ) 

Sets a value that defines the dimension or the global number of objects of a specific mesh entity.

Ahead of any mesh being written, the mesh dimension and global mesh sizes must be set. Typically the number of Cells, Faces and Nodes must be supplied. The type of the data being set is defined using the [MeshSizeType](group__typedefs.xhtml#ga03dbd95a6fee8297703cdb73a0be5e19) enumerated type

Parameters type\[in\] - The type of mesh size for which the value is to be set. size\[in\] - The value to be set. 



<a id="ae323125334ed9fb3d4d62796e08a8451" name="ae323125334ed9fb3d4d62796e08a8451"></a>## [◆ ](#ae323125334ed9fb3d4d62796e08a8451)setMeshUnits()

 void ansys::CffBase::setMeshUnits  ( const std::string &amp;  *units* = `"m"`) 

Define the units of length the mesh is defined in.

By default the units are in the SI unit of length "m"

Parameters units\[in\] - The units the mesh is defined in. 



<a id="af769e3a822ffc4c0fdf1a729c166c9cb" name="af769e3a822ffc4c0fdf1a729c166c9cb"></a>## [◆ ](#af769e3a822ffc4c0fdf1a729c166c9cb)setNodeZoneInfo()

 void ansys::CffBase::setNodeZoneInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *nodeZoneId*,    const [NodeZoneInfoType](group__enums.xhtml#gacc3f469fa6326c4b75b40d9e4f8313db)  *nodeZoneInfoType*,    const int  *info*   )  const

set certain zone level info for a node zone.

Parameters nodeZoneId\[in\] - The zone Id, of which the zone info will be set nodeZoneInfoType\[in\] - The zone info type to set, refer [CffNodeZoneInfoType](group__enums.xhtml#gacc3f469fa6326c4b75b40d9e4f8313db "An enumerated type that used when querying or setting information that is specific to a node zones us...") for all node zone info types info\[in\] - The actual data for the zone info type 



<a id="acd0f72767680be525a7445e07fb3b9ba" name="acd0f72767680be525a7445e07fb3b9ba"></a>## [◆ ](#acd0f72767680be525a7445e07fb3b9ba)setPartitionId()

 void ansys::CffBase::setPartitionId  ( const [PartitionIdType](group__typedefs.xhtml#gaa0b01fb68d68067022164a7fcb5cb0e5)  *pId*) 





<a id="a7580864520aebd0a63c0e3f4490c8ea3" name="a7580864520aebd0a63c0e3f4490c8ea3"></a>## [◆ ](#a7580864520aebd0a63c0e3f4490c8ea3)setReadNCIOn()

 void ansys::CffBase::setReadNCIOn  ( bool  *nci*)   virtual 

Turn on/off non-conformal interface reading.

Parameters nci\[in\] - If true, NCI reading is enabled 



<a id="a30ca8450d5f621a2decc2dde0ff9207f" name="a30ca8450d5f621a2decc2dde0ff9207f"></a>## [◆ ](#a30ca8450d5f621a2decc2dde0ff9207f)setSolverType()

 void ansys::CffBase::setSolverType  ( [SolverType](group__typedefs.xhtml#ga195806ab92eb9a11e3bda91098c6ac38)  *solverType*)   virtual 

Set the name of the application that is supplying the data.

When supplyingn a model this function should be called to definie the owner of the data that is in the model. This name is used automatically by the API to determine the CffVariableAttributeProvider that is used to populate the [Ansys Common Fluids Solution Data Model](_solution_d_m.xhtml).

Parameters solverType\[in\] - String representing the application name writing the data e.g. "ANSYS\_FLUENT".   




<a id="a8f9c0f2adda371644dfe678da1bdd9a2" name="a8f9c0f2adda371644dfe678da1bdd9a2"></a>## [◆ ](#a8f9c0f2adda371644dfe678da1bdd9a2)setTarget()

 void ansys::CffBase::setTarget  ( const [TargetCategory](group__enums.xhtml#ga2bf8717ca5a1d17190dddf5faf6efa5d)  *target*) 

Set the target category for which the data is intended.

The target category defines whether the mesh and solution data is written as a CFF Solver Restart data or a CFF Post Processing file.

Restart data is typically intended for use within the solver that wrote the data. This sometimes means that the data read from the file will not be suitable for Post Processing without further manipulation using domain knowledge. See [CFF Restart Format](_file_formats_overview.xhtml#CFFRestart).

Post processing data is always written corrected and in a simplified model that makes Post Processing in ANSYS Ensight quicker. See [CFF Post Format](_file_formats_overview.xhtml#CFFPost)

Parameters target- The category of data being definied.   




<a id="a8070844e08f8fd939cf1a23e1200f374" name="a8070844e08f8fd939cf1a23e1200f374"></a>## [◆ ](#a8070844e08f8fd939cf1a23e1200f374)setTimeLevel()

 bool ansys::CffBase::setTimeLevel  ( [TimeLevelType](group__typedefs.xhtml#gabedb5244490da90f6098241bdc88e24c)  *timeLevel*)  const  protected 





<a id="af65917c8ea7a2165f19462275e4fdc11" name="af65917c8ea7a2165f19462275e4fdc11"></a>## [◆ ](#af65917c8ea7a2165f19462275e4fdc11)setVariableAttributeProvider()

 void ansys::CffBase::setVariableAttributeProvider  ( const CffVariableAttributeProvider \*  *vap*,    bool  *takeOwnership* = `false`   ) 

Register an alternative variable attribute provider.

Often the user may wish to supply variable attributes when reading or writing data. In the reading case this may be because the variable attributes are not in the file and a default provider doesn't exist. When writing the data this may also be the case if the attributes can be supplied from an alternative data source such as a configuration file.

Parameters vap\[in\] - The alternative variable attribute provider. takeOwnership\[in\] - The managementof the memory pointed to by `vap` is controlled by the CFFAPI if true or remains with the user otherwise. In the later case the user should call the function again with a null pointer to remove the reference in the API when no longer required. 



<a id="a5ef5d972c78d183d8d765f1b5578ea57" name="a5ef5d972c78d183d8d765f1b5578ea57"></a>## [◆ ](#a5ef5d972c78d183d8d765f1b5578ea57)setZoneAdjacency()

 void ansys::CffBase::setZoneAdjacency  ( )   protectedvirtual 





<a id="a24487deb6252ec704a446743f74dc84a" name="a24487deb6252ec704a446743f74dc84a"></a>## [◆ ](#a24487deb6252ec704a446743f74dc84a)setZoneCategory()

 void ansys::CffBase::setZoneCategory  ( const [ZoneIds](group__typedefs.xhtml#ga93b257990d79f628e301fb5e39125cfa) &amp;  *zoneIds*,    const [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b)  *zoneCategory*   )   protected 

set the zone categories of all zones of the same zone category

This function can be used to set zone categories of a batch of zones with the same zone category.

Parameters zoneIds\[in\] - zone ids that have the same zone category indicated by the second argument zoneCategory\[in\] - zone category of all the zones indicated by the first argument, all supported zone categories are defined in [ZoneCategory](group__typedefs.xhtml#ga3cc9d15e024ad6722eb61bb422097ba5 "Alias for CffZoneCategory ('C++' API only)") 



<a id="a39f93ca4fe18b77774bf8e8de49761e0" name="a39f93ca4fe18b77774bf8e8de49761e0"></a>## [◆ ](#a39f93ca4fe18b77774bf8e8de49761e0)setZoneIds()

 void ansys::CffBase::setZoneIds  ( const [ZoneCategory](group__enums.xhtml#ga1e26b7f9299129cd1edc8fdf99f2917b)  *zoneCategory*,    const [ZoneIds](group__typedefs.xhtml#ga93b257990d79f628e301fb5e39125cfa) &amp;  *zoneIds*   ) 

Define the zones that are of a specific category.

Zones define collections of nodes, faces or cells. This function defines the zones that exist a specific [ZoneCategory](group__typedefs.xhtml#ga3cc9d15e024ad6722eb61bb422097ba5).

Parameters zoneCategory\[in\] - The category of the zones being supplied. zoneIds\[in\] - Collection of zones Ids that are of category.   




<a id="ab004b191ee5ecb3c4e601e8fdad56c1a" name="ab004b191ee5ecb3c4e601e8fdad56c1a"></a>## [◆ ](#ab004b191ee5ecb3c4e601e8fdad56c1a)setZoneSizeInfo()

 void ansys::CffBase::setZoneSizeInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *zoneId*,    const [ZoneSizeType](group__enums.xhtml#ga54ba682a6deedd60cb203d1963a0ac12)  *sizeType*,    const [ElemIdType](group__typedefs.xhtml#gae50a482a800bfe94fe6b210685908107)  *size*   ) 

Sets a size setting of a zone.

Zones are defined with a dimension, number of objects, and the object Id range (start Id and end Id). This function allows the setting of each individual size independently. The type ofsetting is defined by an enum [ZoneSizeType](group__typedefs.xhtml#ga596f56359ce823cc5274c3a7626a485a).

Parameters zoneId\[in\] - The id of the zone for which the value is being set. sizeType\[in\] - The setting being defined. e.g. CFF\_ZONE\_DIMENSION size\[in\] - The value being set. e.g. 3 



<a id="a41dad7e9d021bdda73c87fe328dc8165" name="a41dad7e9d021bdda73c87fe328dc8165"></a>## [◆ ](#a41dad7e9d021bdda73c87fe328dc8165)setZoneStringInfo()

 void ansys::CffBase::setZoneStringInfo  ( const [ZoneIdType](group__typedefs.xhtml#ga96bae07dc5559ed1e54e8b8919f11b96)  *zoneId*,    const [ZoneStringInfoType](group__enums.xhtml#ga7fe67117cb23bbcbb4ff2d5b55c3a704)  *type*,    const std::string &amp;  *info*   ) 

Sets a string value associated with a zone.

Typically a mesh zone will have a name that identifies it, it may also have a type represented as a string.

To set the appropriate value [ZoneStringInfoType](group__typedefs.xhtml#ga302285ede15d899051c0478f5b8190d6) is passed to the function to indicate the type of setting being supplied.

Parameters zoneId\[in\] - The Id of the Zone for which information is to be set. type\[in\] - The type of string setting being set. info\[in\] - The value of the setting being set. 



<a id="a91b255a6c333f2f5e302fe61a09e5657" name="a91b255a6c333f2f5e302fe61a09e5657"></a>## [◆ ](#a91b255a6c333f2f5e302fe61a09e5657)solutionModel()

 CffSolutionModel \* ansys::CffBase::solutionModel  ( )  const  protected 





<a id="a4705c89685f16a8b76f879dff8d53a4c" name="a4705c89685f16a8b76f879dff8d53a4c"></a>## [◆ ](#a4705c89685f16a8b76f879dff8d53a4c)updateData()

 virtual bool ansys::CffBase::updateData  ( [DataClass](group__enums.xhtml#gab852cc24891eb831942fb8da764d8ddb)  )   inlineprotectedvirtual 





## Member Data Documentation

<a id="abe68a138cc582d12caf4fe858a9c8c94" name="abe68a138cc582d12caf4fe858a9c8c94"></a>## [◆ ](#abe68a138cc582d12caf4fe858a9c8c94)\_data

 std::unique\_ptr&lt;DataInterface&gt; ansys::CffBase::\_data  protected 





<a id="a03d5187e85700144661d5dc477714202" name="a03d5187e85700144661d5dc477714202"></a>## [◆ ](#a03d5187e85700144661d5dc477714202)\_defaultSettingsPath

 std::string ansys::CffBase::\_defaultSettingsPath = "settings"  static 





<a id="a6cc0f9a6020b6a1eb82f705ac2e4a0a2" name="a6cc0f9a6020b6a1eb82f705ac2e4a0a2"></a>## [◆ ](#a6cc0f9a6020b6a1eb82f705ac2e4a0a2)\_varAttrProvider

 std::unique\_ptr&lt;const CffVariableAttributeProvider&gt; ansys::CffBase::\_varAttrProvider  protected