f4enix.output.meshinfo.MeshInfoCyl#

class f4enix.output.meshinfo.MeshInfoCyl(coordinates: CoordinateType, data_mass: DataMass | None, vector_i: list[float], vector_j: list[float], vector_k: list[float], origin: list[float], axis: list[float], vec: list[float])#

Bases: MeshInfo

Same as MeshInfo but adding cylindrical coordinates specific parameters like origin, axis and vec.

Parameters:

  • coordinates (CoordinateType) – either cartesian or cylindrical

  • data_mass (DataMass) – mass data associated to the mesh

  • vector_i (list[float]) – i vector

  • vector_j (list[float]) – j vector

  • vector_k (list[float]) – k vector

  • origin (list[float]) – x, y, z origin of the mesh

  • axis (list[float]) – TBD

  • vec (list[float]) – TBD

Variables:

  • coordinates (CoordinateType) – either cartesian or cylindrical

  • data_mass (DataMass) – mass data associated to the mesh

  • vector_i (np.array) – i vector

  • vector_j (np.array) – j vector

  • vector_k (np.array) – k vector

  • origin (np.array) – x, y, z origin of the mesh

  • axis (np.array) – TBD

  • vec (np.array) – TBD

Methods

__init__(coordinates, data_mass, vector_i, ...)

Same as MeshInfo but adding cylindrical coordinates specific parameters like origin, axis and vec.

load(path_to_folder)

Given the path to the folder where the class was saved, it reads both the JSON file and the data_mass dataframe to recreate the instance of the class.

save(path_to_results)

To save the class all the parameters are saved in a JSON file except the data_mass which is saved as a HDF5 dataframe.
classmethod load(path_to_folder: PathLike) → MeshInfo | MeshInfoCyl#

Given the path to the folder where the class was saved, it reads both the JSON file and the data_mass dataframe to recreate the instance of the class.

Parameters:

path_to_folder (os.PathLike) – folder where the files to be loaded are stored

Returns:

Loaded mesh info

Return type:

MeshInfo | MeshInfoCyl

save(path_to_results: PathLike) → None#

To save the class all the parameters are saved in a JSON file except the data_mass which is saved as a HDF5 dataframe.

Parameters:

path_to_results (os.PathLike) – _description_