abstract_solution_variables

Abstract contracts for Fluent solution-variable services.

Classes:

AbstractData()	Abstract base class for solution variable data.
AbstractSolutionVariableData()	Abstract base class for solution variable data.
AbstractSolutionVariableInfo()	Abstract base class for solution variable information.

class ansys.fluent.core.fields.solution_variables.abstract_solution_variables.AbstractData

Bases: ABC

Abstract base class for solution variable data.

Attributes:

data	Solution variable data.
domain	Domain name.
zone_names	Zone names.

abstract property data: dict[str, ndarray]

Solution variable data.

abstract property domain: str | None

Domain name.

abstract property zone_names: list[str]

Zone names.

class ansys.fluent.core.fields.solution_variables.abstract_solution_variables.AbstractSolutionVariableData

Bases: ABC

Abstract base class for solution variable data.

Methods:

get_data(variable_name, zone_names[, ...])	Get SVAR data on zones.
set_data(variable_name, zone_names_to_data)	Set SVAR data on zones.

abstract get_data(variable_name, zone_names, domain_name='mixture')

Get SVAR data on zones.

Parameters:

variable_namestr

Name of the solution variable.

zone_names: List[str]

Zone names list for solution variable data.

domain_namestr, optional

Domain name. The default is mixture.

Returns:

AbstractData

Object containing SVAR data.

abstract set_data(variable_name, zone_names_to_data, domain_name='mixture')

Set SVAR data on zones.

Parameters:

variable_namestr

Name of the solution variable.

zone_names_to_data: Dict[str, np.array]

Dictionary containing zone names for solution variable data.

domain_namestr, optional

Domain name. The default is mixture.

Returns:

None

class ansys.fluent.core.fields.solution_variables.abstract_solution_variables.AbstractSolutionVariableInfo

Bases: ABC

Abstract base class for solution variable information.

Methods:

get_variables_info(zone_names[, domain_name])	Get SVARs info for zones in the domain.
get_zones_info()	Get Zones info.

abstract get_variables_info(zone_names, domain_name='mixture')

Get SVARs info for zones in the domain.

Parameters:

zone_namesList[str]

List of zone names.

domain_name: str, optional

Domain name.The default is mixture.

Returns:

SolutionVariableInfo.SolutionVariables

Object containing information for SVARs which are common for list of zone names.

abstract get_zones_info()

Get Zones info.

Parameters:

None

Returns:

SolutionVariableInfo.ZonesInfo

Object containing information for all zones.