Point

class Point

Bases: EntityBase

Point class for defining a single point used in various outputs.

Example

>>> fl.Point(
...      name="Point",
...      location=(1.0, 2.0, 3.0) * fl.u.m,
...  )

---

Attributes

name: str

location: LengthType.Vector

The coordinate of the point.

Properties

id: str

Returns private_attribute_id of the entity.

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')