neso_fame.nektar_writer.nektar_mesh(elements: NektarElements, mesh_dim: int, spatial_dim: int, write_movement: bool = True, periodic_interfaces: bool = True, compressed: bool = True) MeshGraphXml | MeshGraphXmlCompressed

Create a Nektar++ MeshGraphXml from Nektar++ geometry objects.

Parameters:
elements: NektarElements

The collection of Nektar++ objects to be assembled into a MeshGraph object.

mesh_dim: int

The dimension of the elements of the mesh.

spatial_dim: int

The dimension of the space in which the mesh elements sit.

write_movement: bool = True

Whether to write information on non-conformal zones and interfaces.

periodic_interfaces: bool = True

If write_movement is True, whether the last layer joins back up with the first, requiring an interface to be defined between the two.

compressed: bool = True

Whether to return a MeshGraphXmlCompressed object or a plain MeshGraphXml object

Danger

Be very careful if calling this function more than once in the same session. The IDs of the geometry objects are only set when creating the MeshGraph in this function and calling it a second time with some of the same elements could result in the ID being changed. You must take particular care because geometry elements are cached. Always write out (or otherwise finish with) a MeshGraph object before calling this method again. The safest way to do this is not to call this function direclty but instead use write_nektar.


Last update: Nov 07, 2024