Implements the weak_gradient_t type.

Data Types
type	weak_gradient_t
	A simulation component that computes the weak gradient of a field. Wraps the `opgradient` operator. More...

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

subroutine	weak_gradient_init_common (this, field_name, computed_field)
	Common part of the constructors.

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

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

subroutine	weak_gradient_free (this)
	Destructor.

subroutine	weak_gradient_compute (this, time)
	Compute the weak_gradient field.

Function/Subroutine Documentation

◆ weak_gradient_compute()

subroutine weak_gradient_simcomp::weak_gradient_compute	(	class(weak_gradient_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

private

Parameters

time	The current time value

Definition at line 236 of file weak_gradient_simcomp.f90.

Here is the call graph for this function:

subroutine weak_gradient_simcomp::weak_gradient_free ( class(weak_gradient_t), intent(inout) this )

private

Definition at line 224 of file weak_gradient_simcomp.f90.

subroutine weak_gradient_simcomp::weak_gradient_init_common	(	class(weak_gradient_t), intent(inout)	this,
		character(len=*)	field_name,
		character(len=*)	computed_field
	)

private

Definition at line 117 of file weak_gradient_simcomp.f90.

subroutine weak_gradient_simcomp::weak_gradient_init_from_controllers	(	class(weak_gradient_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=*)	field_name,
		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_name	The name of the field to compute the weak_gradient of.
computed_field	The base name of the weak_gradient 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 145 of file weak_gradient_simcomp.f90.

subroutine weak_gradient_simcomp::weak_gradient_init_from_controllers_properties	(	class(weak_gradient_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=*)	field_name,
		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_name	The name of the field to compute the weak_gradient of.
computed_field	The base name of the weak_gradient 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 189 of file weak_gradient_simcomp.f90.

subroutine weak_gradient_simcomp::weak_gradient_init_from_json	(	class(weak_gradient_t), intent(inout), target	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

Definition at line 90 of file weak_gradient_simcomp.f90.