Neko-TOP
A portable framework for high-order spectral element flow toplogy optimization.
Loading...
Searching...
No Matches
linear_mapping::linear_mapping_t Type Referenceabstract

A linear mapping of coefficients $f(x) = f_{min} + (f_{max} - f_{min}) x$. More...

Inheritance diagram for linear_mapping::linear_mapping_t:
Collaboration diagram for linear_mapping::linear_mapping_t:

Public Member Functions

procedure, pass(this) init (this, json, coef)
 Constructor from json.
 
procedure, pass(this) init_from_attributes (this, coef, f_min, f_max)
 Actual constructor.
 
procedure, pass(this) free (this)
 Destructor.
 
procedure, pass(this) forward_mapping (this, x_out, x_in)
 Apply the forward mapping.
 
procedure, pass(this) backward_mapping (this, sens_out, sens_in, x_in)
 Apply the adjoint mapping.
 
procedure, pass(this) init_base (this, json, coef)
 Constructor for the mapping_t class.
 
procedure, pass(this) free_base (this)
 Destructor for the mapping_t (base) class.
 
procedure, pass(this) apply_forward (this, x_out, x_in)
 Apply the forward mapping.
 
procedure, pass(this) apply_backward (this, sens_out, sens_in)
 Apply the backward mapping (ie, chain rule)
 
procedure(mapping_init), deferred, pass init (this, json, coef)
 The common constructor using a JSON dictionary.
 
procedure(mapping_free), deferred, pass free (this)
 Destructor.
 
procedure(mapping_forward_mapping), deferred, pass forward_mapping (this, x_out, x_in)
 forward mapping to be computed
 
procedure(mapping_backward_mapping), deferred, pass backward_mapping (this, sens_out, sens_in, x_in)
 Backward mapping to be computed.
 

Public Attributes

real(kind=rp) f_min
 minimum value
 
real(kind=rp) f_max
 maximum value
 
type(coef_t), pointer coef => null()
 Coefficients for the SEM.
 
type(field_t) x_in
 A copy of the unmapped field (often used for chain rule)
 

Detailed Description

Definition at line 48 of file linear_mapping.f90.

Member Function/Subroutine Documentation

◆ apply_backward()

procedure, pass(this) mapping::mapping_t::apply_backward ( class(mapping_t), intent(inout)  this,
type(field_t), intent(inout)  sens_out,
type(field_t), intent(in)  sens_in 
)
inherited
Parameters
thisThe mapping object
sens_insensitivity wrt to the mapped field ( \(\frac{\partial F}{\partial \tilde{\rho}}\))
sens_outsensitivity wrt to the unmapped field ( \(\frac{\partial F}{\partial \rho}\))

Definition at line 59 of file mapping.f90.

◆ apply_forward()

procedure, pass(this) mapping::mapping_t::apply_forward ( class(mapping_t), intent(inout)  this,
type(field_t), intent(inout)  x_out,
type(field_t), intent(in)  x_in 
)
inherited
Parameters
thisThe mapping object
X_outThe mapped field ( \(\tilde{\rho}\))
X_inThe unmapped field ( \(\rho\))

Definition at line 57 of file mapping.f90.

◆ backward_mapping() [1/2]

procedure, pass(this) linear_mapping::linear_mapping_t::backward_mapping ( class(linear_mapping_t), intent(inout)  this,
type(field_t), intent(inout)  sens_out,
type(field_t), intent(in)  sens_in,
type(field_t), intent(in)  x_in 
)
Parameters
thisthe mapping
X_inunmapped field
sens_outis the sensitivity with respect to the unfiltered design
sens_inis the sensitivity with respect to the filtered design

Definition at line 65 of file linear_mapping.f90.

◆ backward_mapping() [2/2]

procedure(mapping_backward_mapping), deferred, pass mapping::mapping_t::backward_mapping ( class(mapping_t), intent(inout)  this,
type(field_t), intent(inout)  sens_out,
type(field_t), intent(in)  sens_in,
type(field_t), intent(in)  x_in 
)
pure virtualinherited

Definition at line 67 of file mapping.f90.

◆ forward_mapping() [1/2]

procedure, pass(this) linear_mapping::linear_mapping_t::forward_mapping ( class(linear_mapping_t), intent(inout)  this,
type(field_t), intent(inout)  x_out,
type(field_t), intent(in)  x_in 
)
Parameters
thisthe mapping
X_outmapped field
X_inunmapped field

Definition at line 63 of file linear_mapping.f90.

◆ forward_mapping() [2/2]

procedure(mapping_forward_mapping), deferred, pass mapping::mapping_t::forward_mapping ( class(mapping_t), intent(inout)  this,
type(field_t), intent(inout)  x_out,
type(field_t), intent(in)  x_in 
)
pure virtualinherited

Definition at line 65 of file mapping.f90.

◆ free() [1/2]

procedure, pass(this) linear_mapping::linear_mapping_t::free ( class(linear_mapping_t), intent(inout)  this)

Definition at line 61 of file linear_mapping.f90.

◆ free() [2/2]

procedure(mapping_free), deferred, pass mapping::mapping_t::free ( class(mapping_t), intent(inout)  this)
pure virtualinherited

Definition at line 63 of file mapping.f90.

◆ free_base()

procedure, pass(this) mapping::mapping_t::free_base ( class(mapping_t), intent(inout)  this)
inherited

Definition at line 55 of file mapping.f90.

◆ init() [1/2]

procedure, pass(this) linear_mapping::linear_mapping_t::init ( class(linear_mapping_t), intent(inout)  this,
type(json_file), intent(inout)  json,
type(coef_t), intent(inout)  coef 
)

Definition at line 56 of file linear_mapping.f90.

◆ init() [2/2]

procedure(mapping_init), deferred, pass mapping::mapping_t::init ( class(mapping_t), intent(inout)  this,
type(json_file), intent(inout)  json,
type(coef_t), intent(inout)  coef 
)
pure virtualinherited

Definition at line 61 of file mapping.f90.

◆ init_base()

procedure, pass(this) mapping::mapping_t::init_base ( class(mapping_t), intent(inout)  this,
type(json_file), intent(inout)  json,
type(coef_t), intent(inout), target  coef 
)
inherited

Definition at line 53 of file mapping.f90.

◆ init_from_attributes()

procedure, pass(this) linear_mapping::linear_mapping_t::init_from_attributes ( class(linear_mapping_t), intent(inout)  this,
type(coef_t), intent(inout)  coef,
real(kind=rp), intent(in)  f_min,
real(kind=rp), intent(in)  f_max 
)

Definition at line 58 of file linear_mapping.f90.

Member Data Documentation

◆ coef

type(coef_t), pointer mapping::mapping_t::coef => null()
inherited

Definition at line 47 of file mapping.f90.

◆ f_max

real(kind=rp) linear_mapping::linear_mapping_t::f_max

Definition at line 52 of file linear_mapping.f90.

◆ f_min

real(kind=rp) linear_mapping::linear_mapping_t::f_min

Definition at line 50 of file linear_mapping.f90.

◆ x_in

type(field_t) mapping::mapping_t::x_in
inherited

Definition at line 49 of file mapping.f90.


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