Implements the curl_t type.

Data Types
type	curl_t
	A simulation component that computes the curl of a vector field. Added to the field registry as `curl_x`, `curl_y, and`curl_z` by default, but can be controlled by the computed_field keyword. More...

Functions/Subroutines
subroutine	curl_init_from_json (this, json, case)
	Constructor from json.

subroutine	curl_init_common (this, field_names, computed_field)
	Common part of the constructors.

subroutine	curl_init_from_controllers (this, case, order, preprocess_controller, compute_controller, output_controller, field_names, computed_field, filename, precision)
	Constructor from components, passing controllers.

subroutine	curl_init_from_controllers_properties (this, case, order, preprocess_control, preprocess_value, compute_control, compute_value, output_control, output_value, field_names, computed_field, filename, precision)
	Constructor from components, passing properties to the time_based_controller` components in the base type.

subroutine	curl_free (this)
	Destructor.

subroutine	curl_compute (this, time)
	Compute the curl field.

Function/Subroutine Documentation

◆ curl_compute()

subroutine curl_simcomp::curl_compute	(	class(curl_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

private

Definition at line 256 of file curl_simcomp.f90.

Here is the call graph for this function:

subroutine curl_simcomp::curl_free ( class(curl_t), intent(inout) this )

private

Definition at line 242 of file curl_simcomp.f90.

subroutine curl_simcomp::curl_init_common	(	class(curl_t), intent(inout)	this,
		character(len=*), dimension(3)	field_names,
		character(len=*)	computed_field
	)

private

Parameters

field_names	The names of the fields to compute the curl of.
computed_field	The base name of the curl field components.

Definition at line 133 of file curl_simcomp.f90.

Here is the caller graph for this function:

subroutine curl_simcomp::curl_init_from_controllers	(	class(curl_t), intent(inout)	this,
		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=*), dimension(3)	field_names,
		character(len=*)	computed_field,
		character(len=*), intent(in), optional	filename,
		integer, intent(in), optional	precision
	)

private

Parameters

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.
field_names	The name of the fields to compute the curl of.
computed_field	The base name of the curl field components.
filename	The name of the file save the fields to. Optional, if not
precision	The real precision of the output data. Optional, defaults to single precision.

Definition at line 163 of file curl_simcomp.f90.

subroutine curl_simcomp::curl_init_from_controllers_properties	(	class(curl_t), intent(inout)	this,
		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=*), dimension(3)	field_names,
		character(len=*)	computed_field,
		character(len=*), intent(in), optional	filename,
		integer, intent(in), optional	precision
	)

private

Parameters

case	The simulation case object.
order	The execution oder priority of the simcomp.
preprocess_controller	Control mode for preprocessing.
preprocess_value	Value parameter for preprocessing.
compute_controller	Control mode for computing.
compute_value	Value parameter for computing.
output_controller	Control mode for output.
output_value	Value parameter for output.
field_names	The name of the field to compute the curl of.
computed_field	The base name of the curl field components.
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.

Definition at line 207 of file curl_simcomp.f90.

subroutine curl_simcomp::curl_init_from_json	(	class(curl_t), intent(inout), target	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

Definition at line 100 of file curl_simcomp.f90.

Here is the call graph for this function: