Outputs

class freshkiss3d.VTKWriter

Write solution in VTK file.

Parameters

  • triangular_mesh (freshkiss3d.mesh.TriangularMesh) – Simulation’s triangular mesh

  • vtk_format (string) – Format used to write solution: UGRID_T, UGRID_P, POLYDATA or ALL (default: UGRID_P)

  • scheduler (freshkiss3d.Scheduler) – VTK writing scheduler (default: write 10 files, max: 1000 files).

  • output_dir (string) – Output directory (default: ‘outputs/hydrodynamic_vtk’)

  • scale_h (float) – Scaling factor in z-direction for better visualization (default: 1.)

  • use_cio (bool) – Use C IO function instead of Python (default: True)

  • debug (bool) – Plot visu1 and visu2 debug variables (default: False)

Examples using freshkiss3d.VTKWriter

Water drop

Water drop

Water drop
Canal

Canal

Canal
Height source

Height source

Height source
Tracer source

Tracer source

Tracer source
Vertical flowrate

Vertical flowrate

Vertical flowrate
River

River

River
Stationnary vortex

Stationnary vortex

Stationnary vortex
Topography source

Topography source

Topography source
class freshkiss3d.VTKReader

Read solution from VTK file.

Parameters

  • topography (float [NC]) – Simulation’s topography

  • NL (int) – Number of layers

  • filename (string) – Name of the VTK file to read

  • N_tracers (int) – Number of tracers in VTK file (default: 0)

  • vtk_format (string) – Kind of format used in VTK file (default: POLYDATA)

  • output_dir (string) – Output directory to read VTK file from (default: ‘outputs/hydrodynamic_vtk’)

  • scale_h (float) – Scaling factor in z-direction for better visualization (for example with Paraview). (default: 1.)

read_solution

Read solution from POLYDATA VTK file.

Returns:

x: float [NC]

y: float [NC]

z: float [NC,NL]

H: float [NC]

U: float [NC,NL]

V: float [NC,NL]

W: float [NC,NL]

Rho: float [NC,NL]

Tracers: list(float [NC,NL])

class freshkiss3d.TXTWriter

Write solution in TXT file for selected cells.

Parameters

  • cells (int[]) – List of cells to save

  • scheduler (freshkiss3d.Scheduler) – Writting TXT solution scheduler (default: write 10 files).

  • output_dir (string) – Output directory to write TXT file in (default: ‘outputs/hydrodynamic_vtk’)

class freshkiss3d.TXTReader

Read solution from TXT file for selected cells.

Parameters

  • cells (int[]) – List of cells to save

  • NL (int) – Number of layers

  • N_tracers (int) – Number of tracers in TXT file (default: 0)

  • vtk_output_dir (string) – Output directory to read TXT file from (default: ‘outputs/hydrodynamic_txt’)

NO

Number of time saved (or number of TXTWriter.write_solution() calls)

Type

int

read_solution

Read solution from TXT file.

Returns:

time: float [NO]

z_layer: float [NC,NL,NO]

H: float [NC,NO]

U: float [NC,NL,NO]

V: float [NC,NL,NO]

W: float [NC,NL,NO]

Rho: float [NC,NL,NO]

Tracers: list(float [NC,NL,NO])