adjoint_lube_source_term::adjoint_lube_source_term_t Type Reference

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:

Public Member Functions
procedure, pass(this)	init (this, json, fields, coef, variable_name)
	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, c_xh_gl, gll_to_gl, dealias, volume, scratch_gl)
	The constructor from type components.
procedure, pass(this)	free (this)
	Destructor.
procedure, pass(this)	compute_ (this, time)
	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?
logical	dealias
	should dealiasing be used?
type(space_t), pointer	xh_gll
	The original space used in the simulation.
type(space_t), pointer	xh_gl
	The additional higher-order space used in dealiasing.
type(coef_t), pointer	c_xh_gl
	cfs of the higher-order space
type(interpolator_t), pointer	gll_to_gl
	Interpolator between the original and higher-order spaces.
type(scratch_registry_t), pointer	scratch_gl
	GL scratch registry.
real(kind=rp)	volume
	Volume of the objective domain.

Detailed Description

Definition at line 72 of file adjoint_lube_source_term.f90.

Member Function/Subroutine Documentation

compute_()

procedure, pass(this) adjoint_lube_source_term::adjoint_lube_source_term_t::compute_	(	class(adjoint_lube_source_term_t), intent(inout)	this,
		type(time_state_t), intent(in)	time
	)

Parameters

this	The source term.
time	The time state.

Definition at line 112 of file adjoint_lube_source_term.f90.

free()

procedure, pass(this) adjoint_lube_source_term::adjoint_lube_source_term_t::free

(

class(adjoint_lube_source_term_t), intent(inout)

this

)

Definition at line 110 of file adjoint_lube_source_term.f90.

init()

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,
		character(len=*), intent(in)	variable_name
	)

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.
variable_name	The name of the variable where the source term acts.

Definition at line 105 of file adjoint_lube_source_term.f90.

init_from_components()

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), intent(in)	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,
		type(coef_t), intent(in), target	c_xh_gl,
		type(interpolator_t), intent(in), target	gll_to_gl,
		logical, intent(in)	dealias,
		real(kind=rp), intent(in)	volume,
		type(scratch_registry_t), intent(in), target	scratch_gl
	)

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.
c_Xh_GL	The SEM coeffs on the over integration mesh.
GLL_to_GL	Interpolator between GLL and GL.
dealias	weather this term should be overintegrated.
volume	volume of the objective domain.
scratch_GL	A scratch registry on the GL space.

Definition at line 107 of file adjoint_lube_source_term.f90.

Member Data Documentation

c_xh_gl

type(coef_t), pointer adjoint_lube_source_term::adjoint_lube_source_term_t::c_xh_gl

Definition at line 95 of file adjoint_lube_source_term.f90.

chi

type(field_t), pointer adjoint_lube_source_term::adjoint_lube_source_term_t::chi => null()

Definition at line 81 of file adjoint_lube_source_term.f90.

dealias

logical adjoint_lube_source_term::adjoint_lube_source_term_t::dealias

Definition at line 89 of file adjoint_lube_source_term.f90.

gll_to_gl

type(interpolator_t), pointer adjoint_lube_source_term::adjoint_lube_source_term_t::gll_to_gl

Definition at line 97 of file adjoint_lube_source_term.f90.

if_mask

logical adjoint_lube_source_term::adjoint_lube_source_term_t::if_mask

Definition at line 87 of file adjoint_lube_source_term.f90.

k

real(kind=rp) adjoint_lube_source_term::adjoint_lube_source_term_t::k

Definition at line 83 of file adjoint_lube_source_term.f90.

mask

class(point_zone_t), pointer adjoint_lube_source_term::adjoint_lube_source_term_t::mask => null()

Definition at line 85 of file adjoint_lube_source_term.f90.

scratch_gl

type(scratch_registry_t), pointer adjoint_lube_source_term::adjoint_lube_source_term_t::scratch_gl

Definition at line 99 of file adjoint_lube_source_term.f90.

u

type(field_t), pointer adjoint_lube_source_term::adjoint_lube_source_term_t::u => null()

Definition at line 75 of file adjoint_lube_source_term.f90.

v

type(field_t), pointer adjoint_lube_source_term::adjoint_lube_source_term_t::v => null()

Definition at line 77 of file adjoint_lube_source_term.f90.

volume

real(kind=rp) adjoint_lube_source_term::adjoint_lube_source_term_t::volume

Definition at line 101 of file adjoint_lube_source_term.f90.

w

type(field_t), pointer adjoint_lube_source_term::adjoint_lube_source_term_t::w => null()

Definition at line 79 of file adjoint_lube_source_term.f90.

xh_gl

type(space_t), pointer adjoint_lube_source_term::adjoint_lube_source_term_t::xh_gl

Definition at line 93 of file adjoint_lube_source_term.f90.

xh_gll

type(space_t), pointer adjoint_lube_source_term::adjoint_lube_source_term_t::xh_gll

Definition at line 91 of file adjoint_lube_source_term.f90.

---

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

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