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

Implements the fluid_source_term_t type. More...

Data Types

type  fluid_source_term_t
 Wrapper contaning and executing the fluid source terms. More...
 

Functions/Subroutines

subroutine fluid_source_term_init (this, json, f_x, f_y, f_z, coef, user)
 Costructor. More...
 
subroutine init_user_source (source_term, rhs_fields, coef, type, user)
 Initialize the user source term. More...
 
subroutine fluid_source_term_free (this)
 Destructor. More...
 
subroutine fluid_source_term_compute (this, t, tstep)
 Add all the source term to the passed right-hand side fields. More...
 

Detailed Description

Implements the fluid_source_term_t type.

Function/Subroutine Documentation

◆ fluid_source_term_compute()

subroutine fluid_source_term::fluid_source_term_compute ( class(fluid_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 197 of file fluid_source_term.f90.

◆ fluid_source_term_free()

subroutine fluid_source_term::fluid_source_term_free ( class(fluid_source_term_t), intent(inout)  this)
private

Destructor.

Definition at line 177 of file fluid_source_term.f90.

◆ fluid_source_term_init()

subroutine fluid_source_term::fluid_source_term_init ( class(fluid_source_term_t), intent(inout)  this,
type(json_file), intent(inout)  json,
type(field_t), intent(in), pointer  f_x,
type(field_t), intent(in), pointer  f_y,
type(field_t), intent(in), pointer  f_z,
type(coef_t), intent(inout)  coef,
type(user_t), intent(in)  user 
)

Costructor.

Definition at line 79 of file fluid_source_term.f90.

Here is the call graph for this function:

◆ init_user_source()

subroutine fluid_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 3 right-hand-side components.
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 159 of file fluid_source_term.f90.

Here is the caller graph for this function: