Neko  0.9.99
A portable framework for high-order spectral element flow simulations
coriolis_source_term Module Reference

Implements the coriolis_source_term_t type. Maintainer: Timofey Mukha.

Data Types

type  coriolis_source_term_t
 This source term adds the Coriolis force. More...
 

Functions/Subroutines

subroutine coriolis_source_term_init_from_json (this, json, fields, coef)
 The common constructor using a JSON object. More...
 
subroutine coriolis_source_term_init_from_components (this, fields, omega, u_geo, coef, start_time, end_time)
 The constructor from type components. More...
 
subroutine coriolis_source_term_free (this)
 Destructor. More...
 
subroutine coriolis_source_term_compute (this, t, tstep)
 Computes the source term and adds the result to fields. More...
 

Function/Subroutine Documentation

◆ coriolis_source_term_compute()

subroutine coriolis_source_term::coriolis_source_term_compute ( class(coriolis_source_term_t), intent(inout)  this,
real(kind=rp), intent(in)  t,
integer, intent(in)  tstep 
)
private
Parameters
tThe time value.
tstepThe current time-step.

Definition at line 161 of file coriolis_source_term.f90.

Here is the call graph for this function:

◆ coriolis_source_term_free()

subroutine coriolis_source_term::coriolis_source_term_free ( class(coriolis_source_term_t), intent(inout)  this)
private

Definition at line 152 of file coriolis_source_term.f90.

◆ coriolis_source_term_init_from_components()

subroutine coriolis_source_term::coriolis_source_term_init_from_components ( class(coriolis_source_term_t), intent(inout)  this,
class(field_list_t), intent(inout), target  fields,
real(kind=rp), dimension(3), intent(in)  omega,
real(kind=rp), dimension(3), intent(in)  u_geo,
type(coef_t 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.
omegaThe rotation vector.
u_geoThe geostrophic wind.
coefThe SEM coeffs.
start_timeWhen to start adding the source term.
end_timeWhen to stop adding the source term.

Definition at line 130 of file coriolis_source_term.f90.

Here is the caller graph for this function:

◆ coriolis_source_term_init_from_json()

subroutine coriolis_source_term::coriolis_source_term_init_from_json ( class(coriolis_source_term_t), intent(inout)  this,
type(json_file), intent(inout)  json,
type(field_list_t), intent(inout), target  fields,
type(coef_t), intent(inout), target  coef 
)
Parameters
jsonThe JSON object for the source.
fieldsA list of fields for adding the source values.
coefThe SEM coeffs.

Definition at line 72 of file coriolis_source_term.f90.

Here is the call graph for this function: