The abstract problem type. More...

Public Member Functions
procedure, pass, public	init (this, parameters, design, simulation)
	Constructor for the base class.

procedure, pass, public	free (this)
	Destructor for the base class.

procedure, pass, public	compute (this, design, simulation)
	Evaluate the optimization problem. This is the main function that evaluates the problem. It should be implemented in the derived classes.

procedure, pass, public	compute_sensitivity (this, design, simulation)
	Evaluate the sensitivity of the optimization problem. This is the main function that evaluates the problem sensitivity to the design. It should be implemented in the derived classes.

procedure, pass, public	read_objectives (this, parameters, design, simulation)
	Read objective json-file.

procedure, pass, public	read_constraints (this, parameters, design, simulation)
	Read constraint json-file.

procedure, pass, public	write (this, idx)
	Sample the problem.

procedure, pass, public	add_objective (this, objective)
	Add an objective to the list.

procedure, pass, public	add_constraint (this, constraint)
	Add a constraint to the list.

procedure, pass(this)	update_objectives (this, design)
	Update the objective function.

procedure, pass(this)	update_constraints (this, design)
	Update the volume constraint.

procedure, pass(this)	update_objective_sensitivities (this, design)
	Update the objective sensitivities.

procedure, pass(this)	update_constraint_sensitivities (this, design)
	Update the constraint sensitivities.

procedure, pass, public	get_objective_value (this, objective_value)
	Return the objective.

procedure, pass, public	get_all_objective_values (this, all_objective_values)
	Return all components of the objective.

procedure, pass, public	get_constraint_values (this, constraint_value)
	Return the constraints.

procedure, pass, public	get_objective_sensitivities (this, sensitivity)
	Return the sensitivity of the objective.

procedure, pass, public	get_constraint_sensitivities (this, sensitivity)
	Return the sensitivity of the constraints.

procedure, pass(this)	get_n_objectives (this)
	Return the number of objectives.

procedure, pass(this)	get_n_constraints (this)
	Return the number of constraints.

procedure, pass(this)	get_log_header (this)
	Return the logfile header.

Public Attributes
integer	n_objectives
	Number of objectives in the problem.

integer	n_constraints
	Number of constraints in the problem.

class(objective_wrapper_t), dimension(:), allocatable	objective_list
	The objective of the problem.

class(constraint_wrapper_t), dimension(:), allocatable	constraint_list
	The constraints of the problem.

Detailed Description

This module defines the problem_t type which is the main interface for the optimization problem. The problem is defined by a set of objectives and constraints that are evaluated based on the design variables. The problem also handles the output of the problem and the simulation.

Definition at line 62 of file problem.f90.

Member Function/Subroutine Documentation

◆ add_constraint()

procedure, pass, public problem::problem_t::add_constraint	(	class(problem_t), intent(inout)	this,
		class(constraint_t), intent(inout), allocatable	constraint
	)

Definition at line 116 of file problem.f90.

◆ add_objective()

procedure, pass, public problem::problem_t::add_objective	(	class(problem_t), intent(inout)	this,
		class(objective_t), intent(inout), allocatable	objective
	)

Definition at line 114 of file problem.f90.

◆ compute()

procedure, pass, public problem::problem_t::compute	(	class(problem_t), intent(inout)	this,
		class(design_t), intent(inout)	design,
		class(simulation_t), intent(inout), optional	simulation
	)

Definition at line 90 of file problem.f90.

◆ compute_sensitivity()

procedure, pass, public problem::problem_t::compute_sensitivity	(	class(problem_t), intent(inout)	this,
		class(design_t), intent(inout)	design,
		class(simulation_t), intent(inout), optional	simulation
	)

Definition at line 95 of file problem.f90.

◆ free()

procedure, pass, public problem::problem_t::free ( class(problem_t), intent(inout) this )

Definition at line 85 of file problem.f90.

◆ get_all_objective_values()

procedure, pass, public problem::problem_t::get_all_objective_values	(	class(problem_t), intent(in)	this,
		type(vector_t), intent(inout)	all_objective_values
	)

This function returns all the indivual objectives comprising the objective function

Parameters

[in]	this	The problem to update the objectives with.
[in,out]	all_objective_values	A vector containing all objectives

Definition at line 141 of file problem.f90.

◆ get_constraint_sensitivities()

procedure, pass, public problem::problem_t::get_constraint_sensitivities	(	class(problem_t), intent(in)	this,
		type(matrix_t), intent(inout)	sensitivity
	)

This function constructs the sensitivity of the constraint values from the individual constraints.

Parameters

[in]	this	The problem to update the objectives with.
[in,out]	sensitivity	The matrix of all constraint sensitivities.

Definition at line 150 of file problem.f90.

◆ get_constraint_values()

procedure, pass, public problem::problem_t::get_constraint_values	(	class(problem_t), intent(in)	this,
		type(vector_t), intent(inout)	constraint_value
	)

This function constructs the constraint values from the individual constraints.

Parameters

[in]	this	The problem to update the objectives with.
[in,out]	constraint_value	The vector of all constraint values.

Definition at line 144 of file problem.f90.

◆ get_log_header()

procedure, pass(this) problem::problem_t::get_log_header ( class(problem_t), intent(in) this )

Definition at line 159 of file problem.f90.

◆ get_n_constraints()

procedure, pass(this) problem::problem_t::get_n_constraints ( class(problem_t), intent(in) this )

Definition at line 156 of file problem.f90.

◆ get_n_objectives()

procedure, pass(this) problem::problem_t::get_n_objectives ( class(problem_t), intent(in) this )

Definition at line 154 of file problem.f90.

◆ get_objective_sensitivities()

procedure, pass, public problem::problem_t::get_objective_sensitivities	(	class(problem_t), intent(in)	this,
		type(vector_t), intent(inout)	sensitivity
	)

This function constructs the sensitivity of the objective value from the individual objectives and their weights.

Parameters

[in]	this	The problem to update the objectives with.
[in,out]	sensitivity	The weighted sum of all objective sensitivities.

Definition at line 147 of file problem.f90.

◆ get_objective_value()

procedure, pass, public problem::problem_t::get_objective_value	(	class(problem_t), intent(in)	this,
		real(kind=rp), intent(out)	objective_value
	)

This function constructs the objective value from the individual objectives and their weights.

Parameters

[in]	this	The problem to update the objectives with.
[out]	objective_value	The weighted sum of all objective values.

Definition at line 138 of file problem.f90.

◆ init()

procedure, pass, public problem::problem_t::init	(	class(problem_t), intent(inout)	this,
		type(json_file), intent(inout)	parameters,
		class(design_t), intent(in)	design,
		type(simulation_t), intent(inout), optional	simulation
	)

Definition at line 83 of file problem.f90.

◆ read_constraints()

procedure, pass, public problem::problem_t::read_constraints	(	class(problem_t), intent(inout)	this,
		type(json_file), intent(inout)	parameters,
		class(design_t), intent(in)	design,
		type(simulation_t), intent(inout), optional	simulation
	)

Definition at line 104 of file problem.f90.

◆ read_objectives()

procedure, pass, public problem::problem_t::read_objectives	(	class(problem_t), intent(inout)	this,
		type(json_file), intent(inout)	parameters,
		class(design_t), intent(in)	design,
		type(simulation_t), intent(inout), optional	simulation
	)

Definition at line 102 of file problem.f90.

◆ update_constraint_sensitivities()

procedure, pass(this) problem::problem_t::update_constraint_sensitivities	(	class(problem_t), intent(inout)	this,
		class(design_t), intent(in)	design
	)

This function should be called after the design has been updated. It will update the sensitivity of all the constraints.

Parameters

[in,out]	this	The problem to update the objectives with.
[in]	design	The design to update the constraints with.

Definition at line 131 of file problem.f90.

◆ update_constraints()

procedure, pass(this) problem::problem_t::update_constraints	(	class(problem_t), intent(inout)	this,
		class(design_t), intent(in)	design
	)

This function should be called after the design has been updated. It will update the value of all the constraints.

Parameters

[in,out]	this	The problem to update the objectives with.
[in]	design	The design to update the constraints with.

Definition at line 125 of file problem.f90.

◆ update_objective_sensitivities()

procedure, pass(this) problem::problem_t::update_objective_sensitivities	(	class(problem_t), intent(inout)	this,
		class(design_t), intent(in)	design
	)

This function should be called after the design has been updated. It will update the sensitivity of all the objectives.

Parameters

[in,out]	this	The problem to update the objectives with.
[in]	design	The design to update the objectives with.

Definition at line 128 of file problem.f90.

◆ update_objectives()

procedure, pass(this) problem::problem_t::update_objectives	(	class(problem_t), intent(inout)	this,
		class(design_t), intent(in)	design
	)

This function should be called after the design has been updated. It will update the value of all the objectives.

Parameters

[in,out]	this	The problem to update the objectives with.
[in]	design	The design to update the objectives with.

Definition at line 122 of file problem.f90.

◆ write()

procedure, pass, public problem::problem_t::write	(	class(problem_t), intent(inout)	this,
		integer, intent(in)	idx
	)

Definition at line 111 of file problem.f90.

Member Data Documentation

◆ constraint_list

class(constraint_wrapper_t), dimension(:), allocatable problem::problem_t::constraint_list

Definition at line 75 of file problem.f90.

◆ n_constraints

integer problem::problem_t::n_constraints

Definition at line 70 of file problem.f90.

◆ n_objectives

integer problem::problem_t::n_objectives

Definition at line 68 of file problem.f90.

◆ objective_list

class(objective_wrapper_t), dimension(:), allocatable problem::problem_t::objective_list

Definition at line 73 of file problem.f90.

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

/home/runner/work/neko-top/neko-top/sources/problems/problem.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ add_constraint()

◆ add_objective()

◆ compute()

◆ compute_sensitivity()

◆ free()

◆ get_all_objective_values()

◆ get_constraint_sensitivities()

◆ get_constraint_values()

◆ get_log_header()

◆ get_n_constraints()

◆ get_n_objectives()

◆ get_objective_sensitivities()

◆ get_objective_value()

◆ init()

◆ read_constraints()

◆ read_objectives()

◆ update_constraint_sensitivities()

◆ update_constraints()

◆ update_objective_sensitivities()

◆ update_objectives()

◆ write()

Member Data Documentation

◆ constraint_list

◆ n_constraints

◆ n_objectives

◆ objective_list