simple_brinkman_source_term::simple_brinkman_source_term_t Type Reference

A simple Brinkman source term. More...

Inheritance diagram for simple_brinkman_source_term::simple_brinkman_source_term_t:

Collaboration diagram for simple_brinkman_source_term::simple_brinkman_source_term_t:

Public Member Functions
procedure, pass(this)	init (this, json, fields, coef)
	The common constructor using a JSON object.
procedure, pass(this)	init_from_components (this, f_x, f_y, f_z, chi, u, v, w, coef)
	The constructor from type components.
procedure, pass(this)	free (this)
	Destructor.
procedure, pass(this)	compute_ (this, t, tstep)
	Computes the source term and adds the result to fields.

Public Attributes
type(field_t), pointer	chi => null()
	the fields corresponding to \(\chi\)
type(field_t), pointer	u => null()
	the fields corresponding to u
type(field_t), pointer	v => null()
	the fields corresponding to v
type(field_t), pointer	w => null()
	the fields corresponding to w

Detailed Description

Definition at line 51 of file simple_brinkman_source_term.f90.

Member Function/Subroutine Documentation

compute_()

procedure, pass(this) simple_brinkman_source_term::simple_brinkman_source_term_t::compute_	(	class(simple_brinkman_source_term_t), intent(inout)	this,
		real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep
	)

Parameters

this	The source term.
t	The time value.
tstep	The current time-step.

Definition at line 71 of file simple_brinkman_source_term.f90.

free()

procedure, pass(this) simple_brinkman_source_term::simple_brinkman_source_term_t::free

(

class(simple_brinkman_source_term_t), intent(inout)

this

)

Definition at line 69 of file simple_brinkman_source_term.f90.

init()

procedure, pass(this) simple_brinkman_source_term::simple_brinkman_source_term_t::init	(	class(simple_brinkman_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

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

Definition at line 63 of file simple_brinkman_source_term.f90.

init_from_components()

procedure, pass(this) simple_brinkman_source_term::simple_brinkman_source_term_t::init_from_components	(	class(simple_brinkman_source_term_t), intent(inout)	this,
		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(field_t), intent(in), target	chi,
		type(field_t), intent(in), target	u,
		type(field_t), intent(in), target	v,
		type(field_t), intent(in), target	w,
		type(coef_t)	coef
	)

Parameters

this	The source term.
f_x,f_y,f_z	the RHS of the equation (either primal or adjoint).
chi	the brinkman amplitude field.
u,v,w	the velocity field (either primal or adjoint).
coef	The SEM coeffs.

Definition at line 66 of file simple_brinkman_source_term.f90.

Member Data Documentation

chi

type(field_t), pointer simple_brinkman_source_term::simple_brinkman_source_term_t::chi => null()

Definition at line 53 of file simple_brinkman_source_term.f90.

u

type(field_t), pointer simple_brinkman_source_term::simple_brinkman_source_term_t::u => null()

Definition at line 55 of file simple_brinkman_source_term.f90.

v

type(field_t), pointer simple_brinkman_source_term::simple_brinkman_source_term_t::v => null()

Definition at line 57 of file simple_brinkman_source_term.f90.

w

type(field_t), pointer simple_brinkman_source_term::simple_brinkman_source_term_t::w => null()

Definition at line 59 of file simple_brinkman_source_term.f90.

---

The documentation for this type was generated from the following file:

• /home/runner/work/neko-top/neko-top/sources/source_terms/simple_brinkman_source_term.f90