Ansys Common Fluids Settings Data Model
Last update: 16.07.2025Settings Data Model
The Setttings Data Model stores a number of keys (strings) that are associated with values. The values may be returned in a number of data types via the CffVariant type.
The model is relatively simple and there are functions in the API that return the available keys:
CffProvider::getSettingsKeys
and also the values associated with them:
CffProvider::getSettings
Currently, only a few settings are common across all solvers that write the model, but in the future, more settings will be standardized, allowing a more common approach to solver configuration processing.
Physics Data Model
The Physics Data Model is part of the Settings Data Model.
There are several types of physics objects, including domains, subdomains, boundaries.
Use the object type as defined above to find out the names of all objects of that type by calling CffProvider::getSettings to access the settings, for example:
std::vector<std::string> domainNames = provider->getSettings(ansys::DataClass::CFF_CASE, "domains").asStringVector();
which will return an array of domain names.
One of the primary functions of the physics settings is to provide the location for each of the objects.
To obtain the location, do the following:
std::string> location = provider->getSettings(ansys::DataClass::CFF_CASE, "domains/<name>/location").asString();
where <name> is one of the domain names returned previously.
You should use the Topology Data Model to resolve the location to the cell zones.