mapping_handler::mapping_handler_t Type Reference

Abstract class for handling mapping_cascade. More...

Collaboration diagram for mapping_handler::mapping_handler_t:

Public Member Functions
procedure, pass(this)	init_base (this, coef)
	Constructor.
procedure, pass(this)	free (this)
	Destructor.
generic	apply_forward (this, x_out, x_in)
	Cycle through all the mapping_cascade and return the final field.
generic	apply_forward (this, x_out, x_in)
	Cycle through all the mapping_cascade and return the final field.
procedure, pass(this)	mapping_handler_apply_forward_field (this, x_out, x_in)
	apply the cascade of mapping_cascade.
procedure, pass(this)	mapping_handler_apply_forward_vector (this, x_out, x_in)
	apply the cascade of mapping_cascade.
generic	apply_backward (this, sens_out, sens_in)
	Cycle backwards through all the mapping_cascade and return the sensitivity.
generic	apply_backward (this, x_out, x_in)
	Cycle backwards through all the mapping_cascade and return the sensitivity.
procedure, pass(this)	mapping_handler_apply_backward_field (this, sens_out, sens_in)
	Apply the cascade of mapping_cascade.
procedure, pass(this)	mapping_handler_apply_backward_vector (this, x_out, x_in)
	apply the cascade of mapping_cascade.
generic	add (this, mapping)
	Generic interface to add a mapping to the list.
generic	add (this, json, name)
	Generic interface to add a mapping to the list.
procedure, pass(this)	add_mapping (this, mapping)
	Append a new mapping to the mapping_cascade array.
procedure, pass(this)	add_json_mappings (this, json, name)
	Read from the json file and initialize the mapping_cascade.
procedure, pass(this)	make_cts (this, fld)
	Force a field to be continuous.

Public Attributes
class(mapping_wrapper_t), dimension(:), allocatable	mapping_cascade
	Array of mapping_cascade.
type(coef_t), pointer	coef
	The coefficients of the (space, mesh) pair.

Detailed Description

This class is responsible for managing the mapping_cascade in a sequential manor. It is also responsible for using the chain rule to propagate sensitivity backwards throughout the system.

Definition at line 64 of file mapping_handler.f90.

Member Function/Subroutine Documentation

add() [1/2]

generic mapping_handler::mapping_handler_t::add	(	class(mapping_handler_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		character(len=*), intent(in)	name
	)

Definition at line 89 of file mapping_handler.f90.

add() [2/2]

generic mapping_handler::mapping_handler_t::add	(	class(mapping_handler_t), intent(inout)	this,
		class(mapping_t), intent(in)	mapping
	)

Parameters

this	The handler object
mapping	The mapping to be added.

Definition at line 89 of file mapping_handler.f90.

add_json_mappings()

procedure, pass(this) mapping_handler::mapping_handler_t::add_json_mappings	(	class(mapping_handler_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		character(len=*), intent(in)	name
	)

Definition at line 94 of file mapping_handler.f90.

add_mapping()

procedure, pass(this) mapping_handler::mapping_handler_t::add_mapping	(	class(mapping_handler_t), intent(inout)	this,
		class(mapping_t), intent(in)	mapping
	)

Parameters

this	The handler object
mapping	The mapping to be added.

Definition at line 91 of file mapping_handler.f90.

apply_backward() [1/2]

generic mapping_handler::mapping_handler_t::apply_backward	(	class(mapping_handler_t), intent(inout)	this,
		type(field_t), intent(inout)	sens_out,
		type(field_t), intent(in)	sens_in
	)

Parameters

this	The handler object
sens_out	The sensitivity after applying the chain rule ( \(\frac{\partial F}{\partial \rho}\))
sens_in	The sensitivity before applying the chain rule ( \(\frac{\partial F}{\partial \tilde{\rho}}\))

Definition at line 84 of file mapping_handler.f90.

apply_backward() [2/2]

generic mapping_handler::mapping_handler_t::apply_backward	(	class(mapping_handler_t), intent(inout)	this,
		type(vector_t), intent(inout)	x_out,
		type(vector_t), intent(in)	x_in
	)

Parameters

this	The handler object
X_out	The sensitivity after applying the chain rule ( \(\frac{\partial F}{\partial \rho}\))
X_in	The sensitivity before applying the chain rule ( \(\frac{\partial F}{\partial \tilde{\rho}}\))

Definition at line 84 of file mapping_handler.f90.

apply_forward() [1/2]

generic mapping_handler::mapping_handler_t::apply_forward	(	class(mapping_handler_t), intent(inout)	this,
		type(field_t), intent(inout)	x_out,
		type(field_t), intent(in)	x_in
	)

Parameters

this	The handler object
X_out	The mapped field ( \(\tilde{\rho}\))
X_in	The unmapped field ( \(\rho\))

Definition at line 78 of file mapping_handler.f90.

apply_forward() [2/2]

generic mapping_handler::mapping_handler_t::apply_forward	(	class(mapping_handler_t), intent(inout)	this,
		type(vector_t), intent(inout)	x_out,
		type(vector_t), intent(in)	x_in
	)

Parameters

this	The handler object
X_out	The mapped vector ( \(\tilde{\rho}\))
X_in	The unmapped vector ( \(\rho\))

Definition at line 78 of file mapping_handler.f90.

free()

procedure, pass(this) mapping_handler::mapping_handler_t::free

(

class(mapping_handler_t), intent(inout)

this

)

Definition at line 76 of file mapping_handler.f90.

init_base()

procedure, pass(this) mapping_handler::mapping_handler_t::init_base	(	class(mapping_handler_t), intent(inout)	this,
		type(coef_t), intent(in), target	coef
	)

Definition at line 74 of file mapping_handler.f90.

make_cts()

procedure, pass(this) mapping_handler::mapping_handler_t::make_cts	(	class(mapping_handler_t), intent(inout)	this,
		type(field_t), intent(inout)	fld
	)

Parameters

this	The handler object
fld	The field to be made continuous.

Definition at line 97 of file mapping_handler.f90.

mapping_handler_apply_backward_field()

procedure, pass(this) mapping_handler::mapping_handler_t::mapping_handler_apply_backward_field	(	class(mapping_handler_t), intent(inout)	this,
		type(field_t), intent(inout)	sens_out,
		type(field_t), intent(in)	sens_in
	)

Parameters

this	The handler object
sens_out	The sensitivity after applying the chain rule ( \(\frac{\partial F}{\partial \rho}\))
sens_in	The sensitivity before applying the chain rule ( \(\frac{\partial F}{\partial \tilde{\rho}}\))

Definition at line 86 of file mapping_handler.f90.

mapping_handler_apply_backward_vector()

procedure, pass(this) mapping_handler::mapping_handler_t::mapping_handler_apply_backward_vector	(	class(mapping_handler_t), intent(inout)	this,
		type(vector_t), intent(inout)	x_out,
		type(vector_t), intent(in)	x_in
	)

Parameters

this	The handler object
X_out	The sensitivity after applying the chain rule ( \(\frac{\partial F}{\partial \rho}\))
X_in	The sensitivity before applying the chain rule ( \(\frac{\partial F}{\partial \tilde{\rho}}\))

Definition at line 87 of file mapping_handler.f90.

mapping_handler_apply_forward_field()

procedure, pass(this) mapping_handler::mapping_handler_t::mapping_handler_apply_forward_field	(	class(mapping_handler_t), intent(inout)	this,
		type(field_t), intent(inout)	x_out,
		type(field_t), intent(in)	x_in
	)

Parameters

this	The handler object
X_out	The mapped field ( \(\tilde{\rho}\))
X_in	The unmapped field ( \(\rho\))

Definition at line 80 of file mapping_handler.f90.

mapping_handler_apply_forward_vector()

procedure, pass(this) mapping_handler::mapping_handler_t::mapping_handler_apply_forward_vector	(	class(mapping_handler_t), intent(inout)	this,
		type(vector_t), intent(inout)	x_out,
		type(vector_t), intent(in)	x_in
	)

Parameters

this	The handler object
X_out	The mapped vector ( \(\tilde{\rho}\))
X_in	The unmapped vector ( \(\rho\))

Definition at line 81 of file mapping_handler.f90.

Member Data Documentation

coef

type(coef_t), pointer mapping_handler::mapping_handler_t::coef

Definition at line 70 of file mapping_handler.f90.

mapping_cascade

class(mapping_wrapper_t), dimension(:), allocatable mapping_handler::mapping_handler_t::mapping_cascade

Note

the order really matter's here since they'll be executed in sequence.

Definition at line 68 of file mapping_handler.f90.

---

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

• /home/runner/work/neko-top/neko-top/sources/mapping_functions/mapping_handler.f90