Implements the hpfrt_source_term_t type.

Data Types
type	hpfrt_source_term_t
	High-pass filter relaxation source term. More...

Functions/Subroutines
subroutine	hpfrt_source_term_init_from_json (this, json, fields, coef, variable_name)
	The common constructor using a JSON object.

subroutine	hpfrt_source_term_init_from_components (this, fields, coef, filter_weight, filter_modes, start_time, end_time, field_name)
	The constructor from type components.

subroutine	hpfrt_source_term_free (this)
	Destructor.

subroutine	hpfrt_source_term_compute (this, time)
	Computes the source term and adds the result to `fields`.

Function/Subroutine Documentation

◆ hpfrt_source_term_compute()

subroutine hpfrt_source_term::hpfrt_source_term_compute	(	class(hpfrt_source_term_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

private

Parameters

time	The time state.

Definition at line 195 of file hpfrt_source_term.f90.

Here is the call graph for this function:

subroutine hpfrt_source_term::hpfrt_source_term_free ( class(hpfrt_source_term_t), intent(inout) this )

private

Definition at line 181 of file hpfrt_source_term.f90.

subroutine hpfrt_source_term::hpfrt_source_term_init_from_components	(	class(hpfrt_source_term_t), intent(inout)	this,
		class(field_list_t), intent(in), target	fields,
		type(coef_t), intent(in), target	coef,
		real(kind=rp), intent(in)	filter_weight,
		integer, intent(in)	filter_modes,
		real(kind=rp), intent(in)	start_time,
		real(kind=rp), intent(in)	end_time,
		character(len=*), intent(in)	field_name
	)

private

Parameters

fields	A list of fields for adding the source values.
coef	The SEM coeffs.
filter_weight	The positive damping coefficient magnitude.
filter_modes	Number of high modes affected by the filter.
start_time	When to start adding the source term.
end_time	When to stop adding the source term.
field_name	Name of the scalar field for scalar source terms.

Definition at line 120 of file hpfrt_source_term.f90.

Here is the caller graph for this function:

subroutine hpfrt_source_term::hpfrt_source_term_init_from_json	(	class(hpfrt_source_term_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		type(field_list_t), intent(in), target	fields,
		type(coef_t), intent(in), target	coef,
		character(len=*), intent(in)	variable_name
	)

Parameters

json	The JSON object for the source.
fields	A list of fields for adding the source values.
coef	The SEM coeffs.
variable_name	The name of the variable where the source term acts.

Definition at line 92 of file hpfrt_source_term.f90.

Here is the call graph for this function: