A adjoint source term corresponding to an objective of. More...

Inheritance diagram for adjoint_lube_source_term::adjoint_lube_source_term_t:

Collaboration diagram for adjoint_lube_source_term::adjoint_lube_source_term_t:

[legend]

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, design, k, u, v, w, mask, if_mask, 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	u => null()
	u of the primal

type(field_t), pointer	v => null()
	v of the primal

type(field_t), pointer	w => null()
	w of the primal

type(field_t), pointer	chi => null()
	\(\chi\) the Brinkman amplitude

real(kind=rp)	k
	a scale for this term

class(point_zone_t), pointer	mask => null()
	A mask for where the source term is evaluated.

logical	if_mask
	containing a mask?

Detailed Description

Member Function/Subroutine Documentation

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

Parameters

procedure, pass(this) adjoint_lube_source_term::adjoint_lube_source_term_t::free ( class(adjoint_lube_source_term_t), intent(inout) this )

procedure, pass(this) adjoint_lube_source_term::adjoint_lube_source_term_t::init	(	class(adjoint_lube_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.

procedure, pass(this) adjoint_lube_source_term::adjoint_lube_source_term_t::init_from_components	(	class(adjoint_lube_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,
		class(design_t), intent(in), target	design,
		real(kind=rp)	k,
		type(field_t), intent(in), target	u,
		type(field_t), intent(in), target	v,
		type(field_t), intent(in), target	w,
		class(point_zone_t), intent(in), target	mask,
		logical	if_mask,
		type(coef_t), intent(in)	coef
	)

Parameters

this	The source term.
f_x,f_y,f_z	the RHS of the adjoint
design	the design
K	a scale
u,v,w	the velocity fields of the primal
mask	the mask for the source term
if_mask	whether to use the mask
coef	The SEM coeffs.