Neko  0.8.1
A portable framework for high-order spectral element flow simulations
scalar_source_term Module Reference

Implements the scalar_source_term_t type. More...

Data Types

type  scalar_source_term_t
 Wrapper contaning and executing the scalar source terms. More...
 

Functions/Subroutines

subroutine scalar_source_term_init (this, json, f, coef, user)
 Constructor. More...
 
subroutine init_user_source (source_term, rhs_fields, coef, type, user)
 Initialize the user source term. More...
 
subroutine scalar_source_term_free (this)
 Destructor. More...
 
subroutine scalar_source_term_compute (this, t, tstep)
 Add all the source term to the passed right-hand side fields. More...
 

Detailed Description

Implements the scalar_source_term_t type.

Function/Subroutine Documentation

◆ init_user_source()

subroutine scalar_source_term::init_user_source ( class(source_term_t), intent(inout), allocatable  source_term,
type(field_list_t rhs_fields,
type(coef_t), intent(inout)  coef,
character(len=*)  type,
type(user_t), intent(in)  user 
)
private

Initialize the user source term.

Parameters
source_termThe allocatable source term to be initialized to a user.
rhs_fieldsThe field list with the right-hand-side.
coefThe SEM coefs.
typeThe type of the user source term, "user_vector" or "user_poinwise".
userThe user type containing the user source term routines.

Definition at line 150 of file scalar_source_term.f90.

Here is the caller graph for this function:

◆ scalar_source_term_compute()

subroutine scalar_source_term::scalar_source_term_compute ( class(scalar_source_term_t), intent(inout)  this,
real(kind=rp), intent(in)  t,
integer, intent(in)  tstep 
)
private

Add all the source term to the passed right-hand side fields.

Parameters
tThe time value.
tstepThe current time step.

Definition at line 186 of file scalar_source_term.f90.

◆ scalar_source_term_free()

subroutine scalar_source_term::scalar_source_term_free ( class(scalar_source_term_t), intent(inout)  this)
private

Destructor.

Definition at line 168 of file scalar_source_term.f90.

◆ scalar_source_term_init()

subroutine scalar_source_term::scalar_source_term_init ( class(scalar_source_term_t), intent(inout)  this,
type(json_file), intent(inout)  json,
type(field_t), intent(in), pointer  f,
type(coef_t), intent(inout)  coef,
type(user_t), intent(in)  user 
)

Constructor.

Definition at line 75 of file scalar_source_term.f90.

Here is the call graph for this function: