flow360.VolumeOutput

class VolumeOutput

Bases: Flow360BaseModel, TimeAverageAnimatedOutput

VolumeOutput class

Parameters:

output_format (Optional[Literal['paraview', 'tecplot', 'both']] = paraview) – animation_frequency : Union[PositiveInt, Literal[-1], NoneType] = -1 animation_frequency_offset : Optional[int] = 0 compute_time_averages : Optional[bool] = False animation_frequency_time_average : Union[PositiveInt, Literal[-1], NoneType] = -1 animation_frequency_time_average_offset : Optional[int] = 0 start_average_integration_step : Union[NonNegativeInt, Literal[-1], NoneType] = -1 output_fields : Optional[List[Literal[‘Cp’, ‘gradW’, ‘kOmega’, ‘Mach’, ‘mut’, ‘mutRatio’, ‘nuHat’, ‘primitiveVars’, ‘qcriterion’, ‘residualNavierStokes’, ‘residualTransition’, ‘residualTurbulence’, ‘s’, ‘solutionNavierStokes’, ‘solutionTransition’, ‘solutionTurbulence’, ‘T’, ‘vorticity’, ‘wallDistance’, ‘numericalDissipationFactor’, ‘residualHeatSolver’, ‘VelocityRelative’, ‘lowMachPreconditionerSensor’, ‘betMetrics’, ‘betMetricsPerDisk’, ‘Coefficient of pressure’, ‘Gradient of primitive solution’, ‘k and omega’, ‘Mach number’, ‘Turbulent viscosity’, ‘Turbulent viscosity and freestream dynamic viscosity ratio’, ‘Spalart-Almaras variable’, ‘rho, u, v, w, p (density, 3 velocities and pressure)’, ‘Q criterion’, ‘N-S residual’, ‘Transition residual’, ‘Turbulence residual’, ‘Entropy’, ‘N-S solution’, ‘Transition solution’, ‘Turbulence solution’, ‘Temperature’, ‘Vorticity’, ‘Wall distance’, ‘NumericalDissipationFactor sensor’, ‘Heat equation residual’, ‘Velocity with respect to non-inertial frame’, ‘Low-Mach preconditioner factor’, ‘BET Metrics’, ‘BET Metrics per Disk’]]] = [‘primitiveVars’, ‘Cp’, ‘mut’, ‘Mach’]

Attributes

Methods

__init__([filename])	Create a new model by parsing and validating input data from keyword arguments.
add_type_field()	Automatically place "type" field with model name in the model field dictionary.
allow_but_remove(values)	root validator for allow_but_remove, e.g., legacy properties that are no longer in use
append(params[, overwrite])	append parametrs to the model
construct([_fields_set])	Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
copy([update])	Copy a Flow360BaseModel.
dict(*args[, exclude])	Returns dict representation of the model.
dict_from_file(filename)	Loads a dictionary containing the model from a .json or .yaml file.
flow360_schema()	Generate a schema json string for the flow360 model
flow360_ui_schema()	Generate a UI schema json string for the flow360 model
from_file(filename)	Loads a Flow360BaseModel from .json, or .yaml file.
from_json(filename, **parse_obj_kwargs)	Load a Flow360BaseModel from .json file.
from_orm(obj)
from_yaml(filename, **parse_obj_kwargs)	Loads Flow360BaseModel from .yaml file.
generate_docstring()	Generates a docstring for a Flow360 model and saves it to the __doc__ of the class.
handle_conflicting_fields(values)	root validator to handle deprecated aliases
handle_deprecated_aliases(values)	root validator to handle deprecated aliases
help([methods])	Prints message describing the fields and methods of a Flow360BaseModel.
json(*args[, exclude])	Returns json representation of the model.
one_of(values)	root validator for require one of
parse_file(path, *[, content_type, ...])
parse_obj(obj)
parse_raw(b, *[, content_type, encoding, ...])
schema([by_alias, ref_template])
schema_json(*[, by_alias, ref_template])
set_will_export_to_flow360(flag)	Recursivly sets flag will_export_to_flow360
to_file(filename)	Exports Flow360BaseModel instance to .json or .yaml file
to_json(filename)	Exports Flow360BaseModel instance to .json file
to_solver(params, **kwargs)	Loops through all fields, for Flow360BaseModel runs .to_solver() recusrively.
to_yaml(filename)	Exports Flow360BaseModel instance to .yaml file.
update_forward_refs(**localns)	Try to update ForwardRefs on fields based on this Model, globalns and localns.
validate(value)

Inherited Common Usage

output_fields

to_solver(params, **kwargs)

Loops through all fields, for Flow360BaseModel runs .to_solver() recusrively. For dimensioned value performs

unit conversion to flow360_base system.

Parameters:

• params (Flow360Params) – Full config definition as Flow360Params.

• exclude (List[str] (optional)) – List of fields to ignore on returned model.

• required_by (List[str] (optional)) – Path to property which requires conversion.

Returns:

returns caller class with units all in flow360 base unit system

Return type:

caller class