Class PenaltyBarrier1D

• Defined in File PenaltyBarrier1D.hh

Inheritance Relationships

Derived Types

• public Mechatronix::Penalty1DBipower (Class Penalty1DBipower)

• public Mechatronix::Penalty1DPower (Class Penalty1DPower)

• public Mechatronix::PenaltyBarrier1Dsubtype (Class PenaltyBarrier1Dsubtype)

Class Documentation

class Mechatronix::PenaltyBarrier1D

Base class for 1D penalty

type	class
WALL_ERF_POWER1	WallErfPower1
WALL_ERF_POWER2	WallErfPower2
WALL_ERF_POWER3	WallErfPower3
WALL_TANH_POWER1	WallTanhPower1
WALL_TANH_POWER2	WallTanhPower2
WALL_TANH_POWER3	WallTanhPower3
WALL_PIECEWISE_POWER1	WallPiecewisePower1
WALL_PIECEWISE_POWER2	WallPiecewisePower2
WALL_PIECEWISE_POWER3	WallPiecewisePower3
PENALTY_REGULAR	WallRegular
PENALTY_SMOOTH	WallSmooth
PENALTY_PIECEWISE	WallPiecewise
BARRIER_1X	Barrier1X
BARRIER_LOG	BarrierLog
BARRIER_LOG_EXP	BarrierLogExp
BARRIER_LOG0	BarrierLog0

Subclassed by Mechatronix::Penalty1DBipower, Mechatronix::Penalty1DPower, Mechatronix::PenaltyBarrier1Dsubtype

Public Types

enum Penalty_Kind

Values:

enumerator GREATER_THAN

enumerator LESS_THAN

enumerator INTERVAL

enumerator POWER

enumerator BIPOWER

enum Regularized_for_Penalty

Values:

enumerator WALL_ERF_POWER1

enumerator WALL_ERF_POWER2

enumerator WALL_ERF_POWER3

enumerator WALL_TANH_POWER1

enumerator WALL_TANH_POWER2

enumerator WALL_TANH_POWER3

enumerator WALL_PIECEWISE_POWER1

enumerator WALL_PIECEWISE_POWER2

enumerator WALL_PIECEWISE_POWER3

enumerator PENALTY_REGULAR

enumerator PENALTY_SMOOTH

enumerator PENALTY_PIECEWISE

enumerator BARRIER_1X

enumerator BARRIER_LOG

enumerator BARRIER_LOG_EXP

enumerator BARRIER_LOG0

Public Functions

inline explicit PenaltyBarrier1D(string const &name)

Construct the penalty.

inline virtual ~PenaltyBarrier1D()

Destroy the penalty.

inline string const &name() const

The name of the penalty.

inline virtual void update_SubType(integer)

change the subtype of the penalty

inline virtual void update_epsilon(real_type)

change the epsilon of the control, used in the continuation

inline virtual void update_tolerance(real_type)

change the tolerance of the control, used in the continuation

virtual void setup(GenericContainer const &gc) = 0

setup parameter for penalty

virtual real_type operator()(real_type) const = 0

evaluate penalty

virtual real_type D(real_type) const = 0

first derivative

virtual real_type DD(real_type) const = 0

second derivative

virtual string info() const = 0

print information about penalty

inline void info(ostream_type &stream) const

inline void set_activation_status(bool on_off)

penalty activation, true=penalty active, false=penalty disable

inline bool get_activation_status() const

read penalty activation status

Protected Functions

integer getType(GenericContainer const &gc) const

integer getSubType(GenericContainer const &gc) const

real_type getEpsilon(GenericContainer const &gc) const

real_type getTolerance(GenericContainer const &gc) const

Protected Attributes

string const m_name

bool m_active

RegularizedBase *m_penbar

bool m_is_a_barrier