field_writer Module Reference

Implements the field_writer_t type.

Data Types
type	field_writer_t
	A simulation component that writes a 3d field to a file. More...

Functions/Subroutines
subroutine	field_writer_init_from_json (this, json, case)
	Constructor from json.
subroutine	field_writer_init_from_controllers (this, name, case, order, preprocess_controller, compute_controller, output_controller, fields, filename, precision, format, subdivide)
	Constructor from components, passing controllers.
subroutine	field_writer_init_from_controllers_properties (this, name, case, order, preprocess_control, preprocess_value, compute_control, compute_value, output_control, output_value, fields, filename, precision, format, subdivide)
	Constructor from components, passing properties to the time_based_controllercomponents in the base type. @param name The unique name of the simcomp. @param case The simulation case object. @param order The execution oder priority of the simcomp. @param preprocess_controller Control mode for preprocessing. @param preprocess_value Value parameter for preprocessing. @param compute_controller Control mode for computing. @param compute_value Value parameter for computing. @param output_controller Control mode for output. @param output_value Value parameter for output. @param fields Array of field names to be sampled. @param filename The name of the file save the fields to. Optional, if not provided, fields are added to the main output file. @param precision The real precision of the output data. Optional, defaults to single precision. @param format The output format of the data. Optional, defaults to "nek5000". @param subdivide Whether to subdivide spectral elements into linear sub-cells. Optional, defaults to.false.`.
subroutine	field_writer_init_common (this, name, fields, filename, precision, format, subdivide)
	Common part of both constructors.
subroutine	field_writer_free (this)
	Destructor.
subroutine	field_writer_compute (this, time)
	Here to comply with the interface, does nothing.

Function/Subroutine Documentation

field_writer_compute()

subroutine field_writer::field_writer_compute ( class(field_writer_t), intent(inout)  this, type(time_state_t), intent(in)  time  )

private

Definition at line 286 of file field_writer.f90.

field_writer_free()

subroutine field_writer::field_writer_free ( class(field_writer_t), intent(inout)  this )

private

Definition at line 279 of file field_writer.f90.

field_writer_init_common()

subroutine field_writer::field_writer_init_common ( class(field_writer_t), intent(inout)  this, character(len=*), intent(in)  name, character(len=20), dimension(:), intent(in)  fields, character(len=*), intent(in), optional  filename, integer, intent(in), optional  precision, character(len=*), intent(in), optional  format, logical, intent(in), optional  subdivide  )

private

Parameters

name	The unique name of the simcomp.
fields	Array of field names to be sampled.
filename	The name of the file save the fields to. Optional, if not provided, fields are added to the main output file.
precision	The real precision of the output data. Optional, defaults to single precision.
format	The output format of the data. Optional, defaults to "nek5000".
subdivide	Whether to subdivide spectral elements into linear sub-cells. Optional, defaults to .false..

Definition at line 222 of file field_writer.f90.

field_writer_init_from_controllers()

subroutine field_writer::field_writer_init_from_controllers ( class(field_writer_t), intent(inout)  this, character(len=*), intent(in)  name, class(case_t), intent(inout), target  case, integer  order, type(time_based_controller_t), intent(in)  preprocess_controller, type(time_based_controller_t), intent(in)  compute_controller, type(time_based_controller_t), intent(in)  output_controller, character(len=20), dimension(:), intent(in)  fields, character(len=*), intent(in), optional  filename, integer, intent(in), optional  precision, character(len=20), intent(in), optional  format, logical, intent(in), optional  subdivide  )

private

Parameters

name	The unique name of the simcomp.
case	The simulation case object.
order	The execution oder priority of the simcomp.
preprocess_controller	The controller for running preprocessing.
compute_controller	The controller for running compute.
output_controller	The controller for producing output.
fields	Array of field names to be sampled.
filename	The name of the file save the fields to. Optional, if not provided, fields are added to the main output file.
precision	The real precision of the output data. Optional, defaults to single precision.
format	The output format of the data. Optional, defaults to "nek5000".
subdivide	Whether to subdivide spectral elements into linear sub-cells. Optional, defaults to .false..

Definition at line 142 of file field_writer.f90.

field_writer_init_from_controllers_properties()

subroutine field_writer::field_writer_init_from_controllers_properties ( class(field_writer_t), intent(inout)  this, character(len=*), intent(in)  name, class(case_t), intent(inout), target  case, integer  order, character(len=*), intent(in)  preprocess_control, real(kind=rp), intent(in)  preprocess_value, character(len=*), intent(in)  compute_control, real(kind=rp), intent(in)  compute_value, character(len=*), intent(in)  output_control, real(kind=rp), intent(in)  output_value, character(len=20), dimension(:), intent(in)  fields, character(len=*), intent(in), optional  filename, integer, intent(in), optional  precision, character(len=*), intent(in), optional  format, logical, intent(in), optional  subdivide  )

private

Definition at line 184 of file field_writer.f90.

field_writer_init_from_json()

subroutine field_writer::field_writer_init_from_json	(	class(field_writer_t), intent(inout), target	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

Parameters

json	JSON object with the parameters.
case	The case object.

Definition at line 89 of file field_writer.f90.