A dummy constraint. More...

Inheritance diagram for dummy_constraint::dummy_constraint_t:

[legend]

Collaboration diagram for dummy_constraint::dummy_constraint_t:

[legend]

Public Member Functions
procedure, pass(this), public	init_json (this, json, design)
	The common constructor using a JSON object.

procedure, pass(this), public	init_from_attributes (this, design)
	The direct initializer from attributes.

procedure, pass(this), public	free (this)
	Destructor.

procedure, pass(this), public	update_value (this, design)
	Computes the source term and adds the result to `fields`.

procedure, pass(this), public	update_sensitivity (this, design)
	Computes the source term and adds the result to `fields`.

procedure, pass(this), public	get_log_size (this)
	Get number of log entries.

procedure, pass(this), public	get_log_headers (this, headers)
	Get header labels for log entries.

procedure, pass(this), public	get_log_values (this, values)
	Get values for log entries.

procedure, pass(this)	init_base (this, name, design_size, mask_name, start_time, end_time)
	Initializer for the base class.

procedure, pass(this)	free_base (this)
	Destructor of the base class.

generic	init (this, json, design)
	Constructor interface.

generic	init (this, json, design, simulation)
	Constructor interface.

procedure, pass(this)	init_json (this, json, design)
	Constructor based on json input.

procedure, pass(this)	init_json_sim (this, json, design, simulation)
	Constructor based on json input and simulation.

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.

procedure, pass(this)	get_log_size (this)
	Get number of log entries for this functional.

procedure, pass(this)	get_log_headers (this, headers)
	Get header labels for this functional's log entries.

procedure, pass(this)	get_log_values (this, values)
	Get values for this functional's log entries.

procedure, pass(this)	reset_value (this)
	Set the value to zero.

procedure, pass(this)	reset_sensitivity (this)
	Set the sensitivity to zero.

procedure, pass(this)	accumulate_value (this, design, time)
	Accumulate the value.

procedure, pass(this)	accumulate_sensitivity (this, design, time)
	Accumulate the sensitivity.

Public Attributes
real(kind=rp)	value = 0.0_rp
	Value of the base_functional.

real(kind=rp)	value_old = 0.0_rp
	Old value for time integration.

type(vector_t)	sensitivity
	Sensitivity field.

type(vector_t)	sensitivity_old
	Old sensitivity field for time integration.

character(len=25)	name = ""
	Name of constraint/objective in the logfile.

logical	has_mask = .false.
	containing a mask

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

real(kind=rp)	start_time = 0.0_rp
	Time window start for accumulation.

real(kind=rp)	end_time = huge(0.0_rp)
	Time window end for accumulation.

Detailed Description

Definition at line 51 of file dummy_constraint.f90.

Member Function/Subroutine Documentation

◆ accumulate_sensitivity()

procedure, pass(this) base_functional::base_functional_t::accumulate_sensitivity	(	class(base_functional_t), intent(inout)	this,
		class(design_t), intent(in)	design,
		type(time_state_t), intent(in)	time
	)

inherited

Definition at line 119 of file base_functional.f90.

◆ accumulate_value()

procedure, pass(this) base_functional::base_functional_t::accumulate_value	(	class(base_functional_t), intent(inout)	this,
		class(design_t), intent(in)	design,
		type(time_state_t), intent(in)	time
	)

inherited

Definition at line 117 of file base_functional.f90.

◆ free() [1/2]

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

pure virtualinherited

Definition at line 94 of file base_functional.f90.

◆ free() [2/2]

procedure, pass(this), public dummy_constraint::dummy_constraint_t::free ( class(dummy_constraint_t), intent(inout) this )

Definition at line 61 of file dummy_constraint.f90.

◆ free_base()

procedure, pass(this) constraint::constraint_t::free_base ( class(constraint_t), intent(inout), target this )

inherited

Definition at line 57 of file constraint.f90.

◆ get_log_headers() [1/2]

procedure, pass(this) base_functional::base_functional_t::get_log_headers	(	class(base_functional_t), intent(in)	this,
		character(len=*), dimension(:), intent(out)	headers
	)

inherited

Parameters

[in]	this	The functional object.
[out]	headers	Header labels for each log entry.

Definition at line 109 of file base_functional.f90.

◆ get_log_headers() [2/2]

procedure, pass(this), public dummy_constraint::dummy_constraint_t::get_log_headers	(	class(dummy_constraint_t), intent(in)	this,
		character(len=*), dimension(:), intent(out)	headers
	)

Parameters

[in]	this	The constraint object.
[out]	headers	Header labels for each log entry.

Definition at line 72 of file dummy_constraint.f90.

◆ get_log_size() [1/2]

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

inherited

Parameters

[in] this The functional object.

Returns: n Number of log entries.

Definition at line 107 of file base_functional.f90.

◆ get_log_size() [2/2]

procedure, pass(this), public dummy_constraint::dummy_constraint_t::get_log_size ( class(dummy_constraint_t), intent(in) this )

Parameters

[in] this The constraint object.

Returns: n Number of log entries.

Definition at line 69 of file dummy_constraint.f90.

◆ get_log_values() [1/2]

procedure, pass(this) base_functional::base_functional_t::get_log_values	(	class(base_functional_t), intent(in)	this,
		real(kind=rp), dimension(:), intent(out)	values
	)

inherited

Parameters

[in]	this	The functional object.
[out]	values	Values corresponding to the log headers.

Definition at line 111 of file base_functional.f90.

◆ get_log_values() [2/2]

procedure, pass(this), public dummy_constraint::dummy_constraint_t::get_log_values	(	class(dummy_constraint_t), intent(in)	this,
		real(kind=rp), dimension(:), intent(out)	values
	)

Parameters

[in]	this	The constraint object.
[out]	values	Values corresponding to the log headers.

Definition at line 75 of file dummy_constraint.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 105 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 103 of file base_functional.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 87 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 87 of file base_functional.f90.

◆ init_base()

procedure, pass(this) constraint::constraint_t::init_base	(	class(constraint_t), intent(inout)	this,
		character(len=*), intent(in)	name,
		integer, intent(in)	design_size,
		character(len=*), intent(in), optional	mask_name,
		real(kind=rp), intent(in), optional	start_time,
		real(kind=rp), intent(in), optional	end_time
	)

inherited

Parameters

this	The constraint object.
name	The name of the constraint.
design_size	The number of design variables.
mask_name	The name design the mask. [optional]
start_time	start of the integration window. [optional]
end_time	end of the integration window. [optional]

Definition at line 55 of file constraint.f90.

◆ init_from_attributes()

procedure, pass(this), public dummy_constraint::dummy_constraint_t::init_from_attributes	(	class(dummy_constraint_t), intent(inout)	this,
		class(design_t), intent(in)	design
	)

Definition at line 58 of file dummy_constraint.f90.

◆ init_json() [1/2]

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 90 of file base_functional.f90.

◆ init_json() [2/2]

procedure, pass(this), public dummy_constraint::dummy_constraint_t::init_json	(	class(dummy_constraint_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		class(design_t), intent(in)	design
	)

Definition at line 55 of file dummy_constraint.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 92 of file base_functional.f90.

◆ reset_sensitivity()

procedure, pass(this) base_functional::base_functional_t::reset_sensitivity ( class(base_functional_t), intent(inout) this )

inherited

Definition at line 115 of file base_functional.f90.

◆ reset_value()

procedure, pass(this) base_functional::base_functional_t::reset_value ( class(base_functional_t), intent(inout) this )

inherited

Definition at line 113 of file base_functional.f90.

◆ update_sensitivity() [1/2]

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 99 of file base_functional.f90.

◆ update_sensitivity() [2/2]

procedure, pass(this), public dummy_constraint::dummy_constraint_t::update_sensitivity	(	class(dummy_constraint_t), intent(inout)	this,
		class(design_t), intent(in)	design
	)

Definition at line 66 of file dummy_constraint.f90.

◆ update_value() [1/2]

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 97 of file base_functional.f90.

◆ update_value() [2/2]

procedure, pass(this), public dummy_constraint::dummy_constraint_t::update_value	(	class(dummy_constraint_t), intent(inout)	this,
		class(design_t), intent(in)	design
	)

Definition at line 63 of file dummy_constraint.f90.

Member Data Documentation

◆ end_time

real(kind=rp) base_functional::base_functional_t::end_time = huge(0.0_rp)

inherited

Definition at line 79 of file base_functional.f90.

◆ has_mask

logical base_functional::base_functional_t::has_mask = .false.

inherited

Definition at line 73 of file base_functional.f90.

◆ mask

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

inherited

Definition at line 75 of file base_functional.f90.

◆ name

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

inherited

Definition at line 71 of file base_functional.f90.

◆ sensitivity

type(vector_t) base_functional::base_functional_t::sensitivity

inherited

Definition at line 67 of file base_functional.f90.

◆ sensitivity_old

type(vector_t) base_functional::base_functional_t::sensitivity_old

inherited

Definition at line 69 of file base_functional.f90.

◆ start_time

real(kind=rp) base_functional::base_functional_t::start_time = 0.0_rp

inherited

Definition at line 77 of file base_functional.f90.

◆ value

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

inherited

Definition at line 63 of file base_functional.f90.

◆ value_old

real(kind=rp) base_functional::base_functional_t::value_old = 0.0_rp

inherited

Definition at line 65 of file base_functional.f90.

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

/home/runner/work/neko-top/neko-top/sources/problem/constraints/dummy_constraint.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ accumulate_sensitivity()

◆ accumulate_value()

◆ free() [1/2]

◆ free() [2/2]

◆ free_base()

◆ get_log_headers() [1/2]

◆ get_log_headers() [2/2]

◆ get_log_size() [1/2]

◆ get_log_size() [2/2]

◆ get_log_values() [1/2]

◆ get_log_values() [2/2]

◆ get_sensitivity()

◆ get_value()

◆ init() [1/2]

◆ init() [2/2]

◆ init_base()

◆ init_from_attributes()

◆ init_json() [1/2]

◆ init_json() [2/2]

◆ init_json_sim()

◆ reset_sensitivity()

◆ reset_value()

◆ update_sensitivity() [1/2]

◆ update_sensitivity() [2/2]

◆ update_value() [1/2]

◆ update_value() [2/2]

Member Data Documentation

◆ end_time

◆ has_mask

◆ mask

◆ name

◆ sensitivity

◆ sensitivity_old

◆ start_time

◆ value

◆ value_old