Optimiser

class compas_tno.optimisers.Optimiser[source]

Bases: compas.datastructures.datastructure.Datastructure

The Optimiser sets the parameters of the optimisation.

Parameters
  • x0 (array) – The starting point of the optimisation.

  • xopt (array) – The value of the variables that solves thhe optimisation problem.

  • fopt (float) – The value of the objective function at the end of the optimisation process.

  • message (str) – The message provided by the solver.

  • M (Problem) – The problem with the relevat matrices.

  • time (float) – The time consumption for solving.

  • niter (int) – The number of iterations.

  • exitflag (int) – Whether or not the optimisation problem was solved successfully. Value ``0``represents a solved problem.

  • log (str) – Log of the optimisation, available for some solves.

  • Settings

  • ——–

  • The main settings and default values are shown below

  • * ‘library’ ([‘Scipy’, ‘MATLAB’, ‘MMA’, ‘IPOPT’, ‘Scipy’, …])

  • * ‘solver’ ([‘SLSQP’, ‘IPOPT’, ‘MMA’, …],)

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

  • * ‘constraints’ ([‘funicular’, ‘envelope’, ‘reac_bounds’, …],)

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

  • * ‘features’ ([‘fixed’, ‘sym’, …],)

  • * ‘find_inds’ (True,)

  • * ‘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

Initiate an empty Optimiser objects, or 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_additional_options

Set the additional options of the optimisation.

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_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_data

Construct an object of this type from the provided data.

from_json

Construct an object from serialized data contained in a JSON file.

from_jsonstring

Construct an object from serialized data contained in a JSON string.

sha256

Compute a hash of the data for comparison during version control using the sha256 algorithm.

to_data

Convert an object to its native data representation.

to_json

Serialize the data representation of an object to a JSON file.

to_jsonstring

Serialize the data representation of an object to a JSON string.

validate_data

Validate the object's data against its data schema.

validate_json

Validate the object's data against its json schema.