flow360.ReferenceFrame

class ReferenceFrame

Bases: ReferenceFrameBase

ReferenceFrame class for setting up reference frame

Parameters:

• model_type (Literal['ReferenceFrame'] = ReferenceFrame) – center : _VectorType axis : Vector parent_volume_name : Optional[str] = None omega : AngularVelocityType

• center (Coordinate) – Coordinate representing the origin of rotation, eg. (0, 0, 0)

• axis (Axis) – Axis of rotation, eg. (0, 0, 1)

• omega (AngularVelocityType) – Rotating speed, for example radians / s

Returns:

An instance of the component class ReferenceFrame.

Return type:

ReferenceFrame

Example

>>> rf = ReferenceFrame(
        center=(0, 0, 0),
        axis=(0, 0, 1),
        omega=1 * u.rad / u.s
    )

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)	returns configuration object in flow360 units system
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

model_type

omega

to_solver(params, **kwargs)

returns configuration object in flow360 units system