Neko 1.99.2
A portable framework for high-order spectral element flow simulations
Loading...
Searching...
No Matches
field_source_term Module Reference

Implements the field_source_term_t type.

Data Types

type  field_source_term_t
 A source term that grabs the values from fields in the registry. The fields are specified with the field_names keyword, which should be an array, with a value for each component of the source. More...
 

Functions/Subroutines

subroutine field_source_term_init_from_json (this, json, fields, coef, variable_name)
 The common constructor using a JSON object.
 
subroutine field_source_term_init_from_components (this, fields, field_names, coef, start_time, end_time)
 The constructor from type components.
 
subroutine field_source_term_free (this)
 Destructor.
 
subroutine field_source_term_compute (this, time)
 Computes the source term and adds the result to fields.
 

Function/Subroutine Documentation

◆ field_source_term_compute()

subroutine field_source_term::field_source_term_compute ( class(field_source_term_t), intent(inout this,
type(time_state_t), intent(in time 
)
private
Parameters
timeThe time state.

Definition at line 142 of file field_source_term.f90.

Here is the call graph for this function:

◆ field_source_term_free()

subroutine field_source_term::field_source_term_free ( class(field_source_term_t), intent(inout this)
private

Definition at line 132 of file field_source_term.f90.

◆ field_source_term_init_from_components()

subroutine field_source_term::field_source_term_init_from_components ( class(field_source_term_t), intent(inout this,
class(field_list_t), intent(in), target  fields,
character(len=*), dimension(:), intent(in field_names,
type(coef_t), target  coef,
real(kind=rp), intent(in start_time,
real(kind=rp), intent(in end_time 
)
private
Parameters
fieldsA list of fields for adding the source values.
field_namesThe name of the fields that define the source term strength.
coefThe SEM coeffs.
start_timeWhen to start adding the source term.
end_timeWhen to stop adding the source term.

Definition at line 100 of file field_source_term.f90.

Here is the caller graph for this function:

◆ field_source_term_init_from_json()

subroutine field_source_term::field_source_term_init_from_json ( class(field_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
jsonThe JSON object for the source.
fieldsA list of fields for adding the source values.
coefThe SEM coeffs.
variable_nameThe name of the variable where the source term acts.

Definition at line 73 of file field_source_term.f90.

Here is the call graph for this function: