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

Implements the user_source_term_t type.

Data Types

type  user_source_term_t
 A source term wrapping the user source term routine. Stores fields that are passed to the user routine so tha the user routine never touches the actual RHS fields directly. More...
 

Functions/Subroutines

subroutine user_source_term_init (this, json, fields, coef, variable_name)
 Costructor from JSON.
 
subroutine user_source_term_init_from_components (this, fields, coef, user_proc, scheme_name)
 Costructor from components.
 
subroutine user_source_term_free (this)
 Destructor.
 
subroutine user_source_term_compute (this, time)
 Computes the source term and adds the result to fields.
 

Function/Subroutine Documentation

◆ user_source_term_compute()

subroutine user_source_term::user_source_term_compute ( class(user_source_term_t), intent(inout this,
type(time_state_t), intent(in time 
)
private
Parameters
timeThe time state.

Definition at line 145 of file user_source_term.f90.

Here is the call graph for this function:

◆ user_source_term_free()

subroutine user_source_term::user_source_term_free ( class(user_source_term_t), intent(inout this)
private

Definition at line 130 of file user_source_term.f90.

◆ user_source_term_init()

subroutine user_source_term::user_source_term_init ( class(user_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 
)

This will throw, as the user source term should be initialized directly from components.

Definition at line 87 of file user_source_term.f90.

◆ user_source_term_init_from_components()

subroutine user_source_term::user_source_term_init_from_components ( class(user_source_term_t), intent(inout this,
type(field_list_t), intent(in), target  fields,
type(coef_t), intent(in), target  coef,
procedure(user_source_term_intf user_proc,
character(len=*), intent(in scheme_name 
)
private
Parameters
fieldsA list of 3 fields for adding the source values.
coefThe SEM coeffs.
user_procThe procedure user procedure to compute the source term.
scheme_nameThe name of the scheme that owns this source term.

Definition at line 104 of file user_source_term.f90.