flow360.SupersonicInflow

class SupersonicInflow

Bases: Boundary

SupersonicInflow class for specifying the full fluid state at supersonic inflow boundaries

Parameters:

• type (Literal['SupersonicInflow'] = SupersonicInflow) – name : Optional[str] = None Optional unique name for boundary.

• total_temperature_ratio (PositiveFloat) – total_pressure_ratio : PositiveFloat static_pressure_ratio : PositiveFloat velocity_direction : Union[Vector, Tuple[pydantic.types.StrictStr, pydantic.types.StrictStr, pydantic.types.StrictStr], NoneType] = None

• total_temperature_ratio – Ratio of total temperature to static temperature at the inlet.

• total_pressure_ratio (PositiveFloat) – Ratio of the total pressure to static pressure at the inlet.

• static_pressure_ratio (PositiveFloat) – Ratio of the inlet static pressure to the freestream static pressure. Default freestream static pressure in Flow360 = 1.0/gamma.

• velocity_direction (BoundaryAxisType) – (Optional) 3-array of either float values or string expressions. Unit vector which specifies the direction of the incoming flow. If not specified, the boundary patch normal is used to specify direction.

Returns:

An instance of the component class SupersonicInflow.

Return type:

SupersonicInflow

Example

>>> supersonicInflow = SupersonicInflow(
    totalTemperatureRatio=2.1,
    totalPressureRatio=3.0,
    staticPressureRatio=1.2
)

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[, exclude, required_by])	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

type

total_temperature_ratio

total_pressure_ratio

static_pressure_ratio

velocity_direction