Optimiser

class compas_tno.optimisers.Optimiser

Bases: Data

The Optimiser sets the parameters of the optimisation.

Parameters:

x0array

The starting point of the optimisation.

xoptarray

The value of the variables that solves thhe optimisation problem.

foptfloat

The value of the objective function at the end of the optimisation process.

messagestr

The message provided by the solver.

MProblem

The problem with the relevat matrices.

timefloat

The time consumption for solving.

niterint

The number of iterations.

exitflagint

Whether or not the optimisation problem was solved successfully. Value 0 represents a solved problem.

logstr

Log of the optimisation, available for some solves.

Attributes:

The main settings and default values are shown below:

* ‘solver’[‘SLSQP’, ‘IPOPT’, …],

* ‘objective’[‘min’, ‘max’, ‘t’, ‘loadpath’, ‘bestfit’, …],

* ‘constraints’[‘funicular’, ‘envelope’, ‘reac_bounds’, …],

* ‘variables’[‘q’, ‘zb’, ‘xyb’, ‘t’, …],

* ‘features’[‘fixed’, ‘sym’, …],

* ‘find_inds’True,

* ‘solver_convex’[‘CLARABEL’, ‘MOSEK’, ‘CVXPY’, …],

* ‘exitflag’1,

* ‘printout’True,

* ‘starting_point’‘current’,

* ‘support_displacement’: None,

* ‘gradient’True,

* ‘jacobian’True,

* ‘solver_options’{},

* ‘max_iter’500,

* ‘qmin’-1e+4,

* ‘qmax’1e-8,

Methods

clear_optimiser	Clear Previous results stored in the Optimiser object.
create_bestfit_optimiser	Create a bestfit optimiser to be sent with instructions to the Analysis.
create_compl_energy_optimiser	Create a linear complementary energy optimiser to be sent with instructions to the Analysis.
create_lp_optimiser	Create a loadpath optimisation optimiser to be sent with instructions to the Analysis.
create_max_horload_optimiser	Create a minimum thickness optimiser to be sent with instructions to the Analysis.
create_max_vertload_optimiser	Create a minimum thickness optimiser to be sent with instructions to the Analysis.
create_maxthrust_optimiser	Create a maximum thickness optimiser to be sent with instructions to the Analysis.
create_minthk_optimiser	Create a minimum thickness optimiser to be sent with instructions to the Analysis.
create_minthrust_optimiser	Create a minimum thickness optimiser to be sent with instructions to the Analysis.
create_quad_compl_energy_optimiser	Create a quadratic complementary energy optimiser to be sent with instructions to the Analysis.
set_axis_symmetry	Set the axis of symmetry.
set_constraints	Set the constraints for the problem.
set_display_options	Set the display options of the optimisation
set_features	Set the features for the problem.
set_gradient_options	Set the display options of the optimisation
set_max_iterations	Set the features for the problem.
set_objective	Set the objective function for the problem.
set_optimiser_options	Set the additional options of the optimisation.
set_solver	Set the features for the problem.
set_starting_point	Set the starating point of the problem.
set_variables	Set the variables for the problem.

Inherited Methods

ToString	Converts the instance to a string.
copy	Make an independent copy of the data object.
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
sha256	Compute a hash of the data for comparison during version control using the sha256 algorithm.
to_json	Convert an object to its native data representation and save it to a JSON file.
to_jsonstring	Convert an object to its native data representation and save it to a JSON string.
validate_data	Validate the data against the object's data schema.