File kernel/src/simulationTools/Relay.hpp

Go to the source code of this file

Linear Complementarity Problem formulation and solving.

class Relay : public LinearOSNS
#include <Relay.hpp>

Formalization and Resolution of a Linear Complementarity Problem (Relay)

Public Functions

Relay(int numericsSolverId = SICONOS_RELAY_AVI_CAOFERRIS)

constructor from numerics solver id

Parameters
  • numericsSolverId: id of numerics solver, default = SICONOS_RELAY_AVI_CAOFERRIS

Relay(SP::SolverOptions options)

constructor from a pre-defined solver options set.

Parameters

~Relay()

destructor

int compute(double time)

Compute the unknown z and w and update the Interaction (y and lambda )

Return

information about the solver convergence.

Parameters
  • time: current time

void display() const

print the data to the screen

const SiconosVector &getLb() const

get the value of lb, the lower bounds of the Relay system

Return

the vector of lower bounds

const SiconosVector &getUb() const

get the value of ub, the upper bounds of the Relay system

Return

the vector of upper bounds

void initialize(SP::Simulation sim)

To initialize the LinearOSNS problem(computes topology …)

Parameters
  • sim: the simulation owning this OSNSPB

SP::SiconosVector lb() const

get lb, the lower bounds of the Relay system

Return

the vector of lower bounds

void setLb(SP::SiconosVector newLb)

set lb to pointer newPtr

Parameters
  • newLb: new lower bound

void setUb(SP::SiconosVector newUb)

set ub to pointer newPtr

Parameters
  • newUb: new upper bound

SP::SiconosVector ub() const

get lb, the lower bounds of the Relay system

Return

the vector of upper bounds

Protected Functions

ACCEPT_SERIALIZATION(Relay)

serialization hooks

Protected Attributes

SP::SiconosVector _lb

contains the vector lb (lower bounds) of a Relay system

SP::RelayProblem _numerics_problem

contains the numerics proble for Relay system

SP::SiconosVector _ub

contains the vector ub (upper bounds) of a Relay system

Friends

friend _BoundsNSLEffect