boussinesq_source_term Module Reference

Implements the boussinesq_source_term_t type.

Data Types
type	boussinesq_source_term_t
	Bouyancy source term accroding to the Boussinesq approximation. More...

Functions/Subroutines
subroutine	boussinesq_source_term_init_from_json (this, json, fields, coef)
	The common constructor using a JSON object.
subroutine	boussinesq_source_term_init_from_components (this, fields, scalar_name, ref_value, g, beta, coef, start_time, end_time)
	The constructor from type components.
subroutine	boussinesq_source_term_free (this)
	Destructor.
subroutine	boussinesq_source_term_compute (this, t, tstep)
	Computes the source term and adds the result to fields.

Function/Subroutine Documentation

boussinesq_source_term_compute()

subroutine boussinesq_source_term::boussinesq_source_term_compute ( class(boussinesq_source_term_t), intent(inout)  this, real(kind=rp), intent(in)  t, integer, intent(in)  tstep  )

private

Parameters

t	The time value.
tstep	The current time-step.

Definition at line 163 of file boussinesq_source_term.f90.

Here is the call graph for this function:

boussinesq_source_term_free()

subroutine boussinesq_source_term::boussinesq_source_term_free ( class(boussinesq_source_term_t), intent(inout)  this )

private

Definition at line 153 of file boussinesq_source_term.f90.

boussinesq_source_term_init_from_components()

subroutine boussinesq_source_term::boussinesq_source_term_init_from_components ( class(boussinesq_source_term_t), intent(inout)  this, class(field_list_t), intent(in), target  fields, character(len=*), intent(in)  scalar_name, real(kind=rp), intent(in)  ref_value, real(kind=rp), dimension(3), intent(in)  g, real(kind=rp), intent(in)  beta, type(coef_t)  coef, real(kind=rp), intent(in)  start_time, real(kind=rp), intent(in)  end_time  )

private

Parameters

fields	A list of fields for adding the source values.
scalar_name	The name of the scalar field driving the source.
ref_value	The reference value of the scalar field.
g	The gravity vector.
beta	The thermal expansion coefficient.
coef	The SEM coeffs.
start_time	When to start adding the source term.
end_time	When to stop adding the source term.

Definition at line 127 of file boussinesq_source_term.f90.

Here is the caller graph for this function:

boussinesq_source_term_init_from_json()

subroutine boussinesq_source_term::boussinesq_source_term_init_from_json	(	class(boussinesq_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
	)

Parameters

json	The JSON object for the source.
fields	A list of fields for adding the source values.
coef	The SEM coeffs.

Definition at line 85 of file boussinesq_source_term.f90.

Here is the call graph for this function: