objective::objective_t Type Reference

The abstract objective type. More...

Inheritance diagram for objective::objective_t:

Collaboration diagram for objective::objective_t:

Public Member Functions
procedure, pass(this)	init_base (this, name, design_size, weight, mask_name)
	Initializer for the base class.
procedure, pass(this)	free_base (this)
	Destructor of the base class.
procedure, pass(this)	get_weight (this)
	Get the weight of the objective.
generic	init (this, json, design)
	Constructor.
generic	init (this, json, design, simulation)
	Constructor.
procedure, pass(this)	init_json (this, json, design)
	Constructor.
procedure, pass(this)	init_json_sim (this, json, design, simulation)
	Constructor.
procedure(functional_free), deferred, pass	free (this)
	Destructor.
procedure(functional_update_value), deferred, pass	update_value (this, design)
	Update the value of the function.
procedure(functional_update_sensitivity), deferred, pass	update_sensitivity (this, design)
	Update the sensitivity of the function.
procedure, pass(this)	get_value (this)
	Get the value of the function.
procedure, pass(this)	get_sensitivity (this, sensitivity)
	Get the sensitivity of the function.

Public Attributes
real(kind=rp)	weight = 1.0_rp
real(kind=rp)	value
	Value of the base_functional.
type(vector_t)	sensitivity
	Sensitivity field.
character(len=25)	name
	Name of constraint/objective in the logfile.
logical	has_mask
	containing a mask
class(point_zone_t), pointer	mask => null()
	A mask for where the objective function is evaluated.

Detailed Description

This is the base class for objectives, which is a type of base functional. Each objective contain a weight that is used to scale the objective value.

Definition at line 51 of file objective.f90.

Member Function/Subroutine Documentation

free()

procedure(functional_free), deferred, pass base_functional::base_functional_t::free ( class(base_functional_t), intent(inout)  this )

pure virtualinherited

Definition at line 81 of file base_functional.f90.

free_base()

procedure, pass(this) objective::objective_t::free_base

(

class(objective_t), intent(inout), target

this

)

Definition at line 59 of file objective.f90.

get_sensitivity()

procedure, pass(this) base_functional::base_functional_t::get_sensitivity ( class(base_functional_t), intent(in)  this, type(vector_t), intent(inout)  sensitivity  )

inherited

Definition at line 92 of file base_functional.f90.

get_value()

procedure, pass(this) base_functional::base_functional_t::get_value ( class(base_functional_t), intent(in)  this )

inherited

Definition at line 90 of file base_functional.f90.

get_weight()

procedure, pass(this) objective::objective_t::get_weight

(

class(objective_t), intent(in)

this

)

Definition at line 61 of file objective.f90.

init() [1/2]

generic base_functional::base_functional_t::init ( class(base_functional_t), intent(inout)  this, type(json_file), intent(inout)  json, class(design_t), intent(in)  design  )

inherited

Definition at line 74 of file base_functional.f90.

init() [2/2]

generic base_functional::base_functional_t::init ( class(base_functional_t), intent(inout)  this, type(json_file), intent(inout)  json, class(design_t), intent(in)  design, type(simulation_t), intent(inout), target  simulation  )

inherited

Definition at line 74 of file base_functional.f90.

init_base()

procedure, pass(this) objective::objective_t::init_base	(	class(objective_t), intent(inout)	this,
		character(len=*), intent(in)	name,
		integer, intent(in)	design_size,
		real(kind=rp), intent(in)	weight,
		character(len=*), intent(in), optional	mask_name
	)

Initialize the objective base class.

Parameters

this	The objective.
name	The name of the objective.
design_size	The number of design variables.
weight	The weight of the objective function.
mask_name	The name design the mask. [optional]

Definition at line 57 of file objective.f90.

init_json()

procedure, pass(this) base_functional::base_functional_t::init_json ( class(base_functional_t), intent(inout)  this, type(json_file), intent(inout)  json, class(design_t), intent(in)  design  )

inherited

Definition at line 77 of file base_functional.f90.

init_json_sim()

procedure, pass(this) base_functional::base_functional_t::init_json_sim ( class(base_functional_t), intent(inout)  this, type(json_file), intent(inout)  json, class(design_t), intent(in)  design, type(simulation_t), intent(inout), target  simulation  )

inherited

Definition at line 79 of file base_functional.f90.

update_sensitivity()

procedure(functional_update_sensitivity), deferred, pass base_functional::base_functional_t::update_sensitivity ( class(base_functional_t), intent(inout)  this, class(design_t), intent(in)  design  )

pure virtualinherited

Definition at line 86 of file base_functional.f90.

update_value()

procedure(functional_update_value), deferred, pass base_functional::base_functional_t::update_value ( class(base_functional_t), intent(inout)  this, class(design_t), intent(in)  design  )

pure virtualinherited

Definition at line 84 of file base_functional.f90.

Member Data Documentation

has_mask

logical base_functional::base_functional_t::has_mask

inherited

Definition at line 65 of file base_functional.f90.

mask

class(point_zone_t), pointer base_functional::base_functional_t::mask => null()

inherited

Definition at line 67 of file base_functional.f90.

name

character(len=25) base_functional::base_functional_t::name

inherited

Definition at line 63 of file base_functional.f90.

sensitivity

type(vector_t) base_functional::base_functional_t::sensitivity

inherited

Definition at line 61 of file base_functional.f90.

value

real(kind=rp) base_functional::base_functional_t::value

inherited

Definition at line 59 of file base_functional.f90.

weight

real(kind=rp) objective::objective_t::weight = 1.0_rp

Definition at line 52 of file objective.f90.

---

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

• /home/runner/work/neko-top/neko-top/sources/problems/objective.f90