mod_ensight_gold::t_ensight_gold Type Reference

Class to write a EnSight Gold file. More...

Public Member Functions
procedure	initialize (ensight, path, base_name, use_constant_mesh)
	Initialize EnSight Gold writer.
procedure	finalize (ensight)
	Finalize EnSight Gold writer.
final	notus_ensight_final (ensight)
procedure	start_iteration (ensight, iteration, time)
	Start an iteration.
procedure	end_iteration (ensight)
	End an iteration.
procedure	write_rectilinear_mesh (ensight, label)
	Write rectilinear mesh.
procedure	write_mof_mesh (ensight, mof_phases, label)
	Write MOF mesh.
generic	write_field (ensight, label, field)
	Write a field.
generic	write_field (ensight, label, field)
	Write a field.
generic	write_field (ensight, label, field)
	Write a field.
generic	write_field (ensight, list)
	Write a field.
procedure	checkpoint_define (ensight, adios_file)
	Checkpoint define.
procedure	checkpoint_write (ensight, adios_file)
	Checkpoint write.
procedure	restart_read (ensight, adios_file)
	Restart.

Private Member Functions
procedure, private	shorten_label (ensight, label)
	Shorten descriptions.
procedure, private	get_time_suffix (ensight)
	Get time suffix.
procedure, private	notus_ensight_write_scalar_field (ensight, label, field)
	Write a scalar field.
procedure, private	notus_ensight_write_vector_field (ensight, label, field)
	Write a vector field.
procedure, private	notus_ensight_write_face_field (ensight, label, field)
	Write a face field.
procedure, private	notus_ensight_write_field_list (ensight, list)
	Write a field list.
procedure, private	write_mof2d_mesh (ensight, mof_phases, label)
	Write MOF 2D mesh.
procedure, private	write_mof3d_mesh (ensight, mof_phases, label)
	Write MOF 3D mesh.

Private Attributes
character(len=:), allocatable, private	path
	Path of the EnSight case file (without extension or iteration number)
character(len=:), allocatable, private	base_name
	Prefix of the EnSight case file (without extension or iteration number)
character(len=:), allocatable, private	output_name
	Effective name of the EnSight case file with full path (path + base_name) (no suffix)
integer, private	iteration = 0
	Current iteration.
double precision, private	time = 0d0
	Current time.
type(mpi_datatype), private	type_scalar_field
type(mpi_datatype), private	type_vector_field
logical, private	use_constant_mesh = .true.
logical, private	use_short_description = .false.
logical, private	is_initialized = .false.
logical, private	is_iteration_started = .false.
integer, private	time_suffix_length = 8
integer, private	case_file = 0
integer, private	file_count = 0

Detailed Description

Class to write a EnSight Gold file.

Format documentation: http://www.civ.cvut.cz/others/ensight/82-UserManual.pdf

Constructor & Destructor Documentation

notus_ensight_final()

final mod_ensight_gold::t_ensight_gold::notus_ensight_final ( type(t_ensight_gold), intent(inout) ensight )

final

Member Function/Subroutine Documentation

checkpoint_define()

procedure mod_ensight_gold::t_ensight_gold::checkpoint_define	(	class(t_ensight_gold), intent(inout)	ensight,
		type(t_adios_writer), intent(inout)	adios_file )

Checkpoint define.

checkpoint_write()

procedure mod_ensight_gold::t_ensight_gold::checkpoint_write	(	class(t_ensight_gold), intent(inout)	ensight,
		type(t_adios_writer), intent(inout)	adios_file )

Checkpoint write.

end_iteration()

procedure mod_ensight_gold::t_ensight_gold::end_iteration

(

class(t_ensight_gold), intent(inout)

ensight

)

End an iteration.

finalize()

procedure mod_ensight_gold::t_ensight_gold::finalize

(

class(t_ensight_gold), intent(inout)

ensight

)

Finalize EnSight Gold writer.

get_time_suffix()

procedure, private mod_ensight_gold::t_ensight_gold::get_time_suffix ( class(t_ensight_gold), intent(inout) ensight )

private

Get time suffix.

initialize()

procedure mod_ensight_gold::t_ensight_gold::initialize	(	class(t_ensight_gold), intent(inout)	ensight,
		character(len=*), intent(in)	path,
		character(len=*), intent(in)	base_name,
		logical, intent(in)	use_constant_mesh )

Initialize EnSight Gold writer.

Multiple call of this routine have not effect.

Parameters

[in,out]	ensight	EnSight Gold writer
[in]	path	path of the EnSight case file
[in]	base_name	base name of the EnSight case file
[in]	use_constant_mesh	the mesh does not depend on time

notus_ensight_write_face_field()

procedure, private mod_ensight_gold::t_ensight_gold::notus_ensight_write_face_field ( class(t_ensight_gold), intent(inout) ensight, character(len=*), intent(in) label, type(t_face_field), intent(in) field )

private

Write a face field.

notus_ensight_write_field_list()

procedure, private mod_ensight_gold::t_ensight_gold::notus_ensight_write_field_list ( class(t_ensight_gold), intent(inout) ensight, type(t_field_list), intent(in) list )

private

Write a field list.

notus_ensight_write_scalar_field()

procedure, private mod_ensight_gold::t_ensight_gold::notus_ensight_write_scalar_field ( class(t_ensight_gold), intent(inout) ensight, character(len=*), intent(in) label, double precision, dimension(:,:,:), intent(in) field )

private

Write a scalar field.

notus_ensight_write_vector_field()

procedure, private mod_ensight_gold::t_ensight_gold::notus_ensight_write_vector_field ( class(t_ensight_gold), intent(inout) ensight, character(len=*), intent(in) label, double precision, dimension(:,:,:,:), intent(in) field )

private

Write a vector field.

restart_read()

procedure mod_ensight_gold::t_ensight_gold::restart_read	(	class(t_ensight_gold), intent(inout)	ensight,
		type(t_adios_reader), intent(inout)	adios_file )

Restart.

shorten_label()

procedure, private mod_ensight_gold::t_ensight_gold::shorten_label ( class(t_ensight_gold), intent(in) ensight, character(len=*), intent(in) label )

private

Shorten descriptions.

start_iteration()

procedure mod_ensight_gold::t_ensight_gold::start_iteration	(	class(t_ensight_gold), intent(inout)	ensight,
		integer, intent(in)	iteration,
		double precision, intent(in)	time )

Start an iteration.

write_field() [1/4]

generic mod_ensight_gold::t_ensight_gold::write_field	(	class(t_ensight_gold), intent(inout)	ensight,
		character(len=*), intent(in)	label,
		double precision, dimension(:,:,:), intent(in)	field )

Write a field.

write_field() [2/4]

generic mod_ensight_gold::t_ensight_gold::write_field	(	class(t_ensight_gold), intent(inout)	ensight,
		character(len=*), intent(in)	label,
		double precision, dimension(:,:,:,:), intent(in)	field )

Write a field.

write_field() [3/4]

generic mod_ensight_gold::t_ensight_gold::write_field	(	class(t_ensight_gold), intent(inout)	ensight,
		character(len=*), intent(in)	label,
		type(t_face_field), intent(in)	field )

Write a field.

write_field() [4/4]

generic mod_ensight_gold::t_ensight_gold::write_field	(	class(t_ensight_gold), intent(inout)	ensight,
		type(t_field_list), intent(in)	list )

Write a field.

write_mof2d_mesh()

procedure, private mod_ensight_gold::t_ensight_gold::write_mof2d_mesh ( class(t_ensight_gold), intent(inout) ensight, type(t_phase_geometry), dimension(:), intent(in) mof_phases, character(len=*), intent(in) label )

private

Write MOF 2D mesh.

write_mof3d_mesh()

procedure, private mod_ensight_gold::t_ensight_gold::write_mof3d_mesh ( class(t_ensight_gold), intent(inout) ensight, type(t_phase_geometry), dimension(:), intent(in) mof_phases, character(len=*), intent(in) label )

private

Write MOF 3D mesh.

write_mof_mesh()

procedure mod_ensight_gold::t_ensight_gold::write_mof_mesh	(	class(t_ensight_gold), intent(inout)	ensight,
		type(t_phase_geometry), dimension(:), intent(in)	mof_phases,
		character(len=*), intent(in)	label )

Write MOF mesh.

write_rectilinear_mesh()

procedure mod_ensight_gold::t_ensight_gold::write_rectilinear_mesh	(	class(t_ensight_gold), intent(inout)	ensight,
		character(len=*), intent(in)	label )

Write rectilinear mesh.

Member Data Documentation

base_name

character(len=:), allocatable, private mod_ensight_gold::t_ensight_gold::base_name

private

Prefix of the EnSight case file (without extension or iteration number)

case_file

integer, private mod_ensight_gold::t_ensight_gold::case_file = 0

private

file_count

integer, private mod_ensight_gold::t_ensight_gold::file_count = 0

private

is_initialized

logical, private mod_ensight_gold::t_ensight_gold::is_initialized = .false.

private

is_iteration_started

logical, private mod_ensight_gold::t_ensight_gold::is_iteration_started = .false.

private

iteration

integer, private mod_ensight_gold::t_ensight_gold::iteration = 0

private

Current iteration.

output_name

character(len=:), allocatable, private mod_ensight_gold::t_ensight_gold::output_name

private

Effective name of the EnSight case file with full path (path + base_name) (no suffix)

path

character(len=:), allocatable, private mod_ensight_gold::t_ensight_gold::path

private

Path of the EnSight case file (without extension or iteration number)

time

double precision, private mod_ensight_gold::t_ensight_gold::time = 0d0

private

Current time.

time_suffix_length

integer, private mod_ensight_gold::t_ensight_gold::time_suffix_length = 8

private

type_scalar_field

type(mpi_datatype), private mod_ensight_gold::t_ensight_gold::type_scalar_field

private

type_vector_field

type(mpi_datatype), private mod_ensight_gold::t_ensight_gold::type_vector_field

private

use_constant_mesh

logical, private mod_ensight_gold::t_ensight_gold::use_constant_mesh = .true.

private

use_short_description

logical, private mod_ensight_gold::t_ensight_gold::use_short_description = .false.

private

---

The documentation for this type was generated from the following file:

• src/lib/io/grids_and_fields/ensight_interface/notus_ensight.f90