flobject

Module for accessing and modifying hierarchy of Fluent settings.

The only useful method is ‘get_root`, which returns the root object for accessing Fluent settings.

Child objects can be generally accessed or modified using attribute access. Named child objects can be accessed or modified using index operators.

Calling an object will return its current value.

Example

>>> r = flobject.get_root(proxy)
>>> is_energy_on = r.setup.models.energy.enabled()
>>> r.setup.models.energy.enabled = True
>>> r.boundary_conditions.velocity_inlet['inlet'].vmag.constant = 20

Functions

assert_type(val, tp)	Assert type.
check_type(val, tp)	Check type of object.
find_children(obj[, identifier])	Returns path of all the child objects matching an identifier.
get_cls(name, info[, parent, version, ...])	Create a class for the object identified by "path".
get_root(flproxy[, version, ...])	Get the root settings object.
to_python_name(fluent_name)	Convert a scheme string to a Python variable name.

Classes

Action([name, parent])	Intermediate Base class for Command and Query class.
Base([name, parent])	Base class for settings and command objects.
BaseCommand([name, parent])	Executes command.
Boolean([name, parent])	A Boolean object representing a Boolean value setting.
BooleanList([name, parent])	A BooleanList object representing a Boolean list setting.
Command([name, parent])	Command object.
CommandWithPositionalArgs([name, parent])	Command Object.
FileName([name, parent])	Resolves MRO for child classes.
Filename([name, parent])	A Filename object representing a file name.
FilenameList([name, parent])	A FilenameList object represents a list of file names.
Group([name, parent])	A Group container object.
Integer([name, parent])	An Integer object representing an integer value setting.
IntegerList([name, parent])	An Integer object representing an integer list setting.
ListObject([name, parent])	A ListObject container is a container object, similar to a Python list object.
Map([name, parent])	A Map object representing key-value settings.
NamedObject([name, parent])	A NamedObject container is a container object similar to a Python dictionary object.
NamedObjectWildcardPath(flproxy, path, ...)	WildcardPath at a NamedObject path, so it can be looked up by wildcard again.
Numerical([name, parent])	Exposes attribute accessor on settings object - specific to numerical objects.
Property([name, parent])	Exposes attribute accessor on settings object.
Query([name, parent])	Query object.
Real([name, parent])	A Real object representing a real value setting.
RealList([name, parent])	A RealList object representing a real list setting.
RealNumerical([name, parent])	A RealNumerical object representing a real value setting, including single real values and containers of real values, such as lists.
RealVector([name, parent])	An object representing a 3D vector.
SettingsBase([name, parent])	Base class for settings objects.
String([name, parent])	A String object representing a string value setting.
StringList([name, parent])	A StringList object representing a string list setting.
Textual([name, parent])	Exposes attribute accessor on settings object - specific to string objects.
WildcardPath(flproxy, path, state_cls, ...)	Class wrapping a wildcard path to perform get_var and set_var on flproxy.

Exceptions

DeprecatedSettingWarning	Provides deprecated settings warning.
InactiveObjectError(python_path)	Inactive object access.
UnstableSettingWarning	Provides unstable settings warning.