PointArray

class PointArray

Bases: EntityBase

PointArray class for defining multiple equally spaced monitor points along a line used in various outputs.

Example

Define PointArray with 6 equally spaced points along a line starting from (0,0,0) * fl.u.m to (1,2,3) * fl.u.m. Both the starting and end points are included in the PointArray.

>>> fl.PointArray(
...     name="Line_1",
...     start=(0.0, 0.0, 0.0) * fl.u.m,
...     end=(1.0, 2.0, 3.0) * fl.u.m,
...     number_of_points=6,
... )

---

Attributes

name: str

start: LengthType.Vector

The starting point of the line.

end: LengthType.Vector

The end point of the line.

number_of_points: int

Number of points along the line.

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')