Constraint solver callback interface with context and start rows for context. More...

#include <NlmcpCallback.h>

Inheritance diagram for agx::ConstraintNlmcpCallback:

Public Member Functions
const ConstraintImplementation *	getContext () const

UInt	getContextDirectRow () const

UInt	getContextIterativeRow () const

Public Member Functions inherited from agx::NlmcpCallback
virtual Real	calculateResidual (const NlmcpCallback::Args &args) const =0
	Calculate residual given current solution.

UInt	getDirectRow () const

UInt	getIterativeRow () const

UInt	getNumRows () const

UInt	getSparseBoundsIndex () const

virtual Bool	initialize (const NlmcpCallback::Args &args)=0
	This method is a test for the non-linear solver if this callback is active for non-linear solve.

virtual void	postIterativeSolve (const NlmcpCallback::Args &args) const =0
	Before direct solve, after iterative solve.

void	setDirectRow (UInt directRow)

void	setIterativeRow (UInt iterativeRow)

void	setNumRows (UInt numRows)

void	setSparseBoundsIndex (UInt sparseBoundsIndex)

virtual void	update (const NlmcpCallback::Args &args) const =0
	Update call when bounds and/or q may be updated given the current solution z.

Public Member Functions inherited from agx::Referenced
	Referenced ()
	Default constructor.

	Referenced (const Referenced &)

template<typename T >
T *	as ()
	Subclass casting.

template<typename T >
const T *	as () const

template<typename T >
T *	asSafe ()
	Safe subclass casting, return nullptr if template type does not match.

template<typename T >
const T *	asSafe () const

int	getReferenceCount () const

template<typename T >
bool	is () const
	Subclass test.

Referenced &	operator= (const Referenced &)
	Assignment operator. Will increment the number of references to the referenced object.

void	reference (void *ptr=nullptr) const
	Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.

void	unreference (void *ptr=nullptr) const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.

void	unreference_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.

Protected Member Functions
	ConstraintNlmcpCallback ()

virtual	~ConstraintNlmcpCallback ()

virtual void	onSetContext (const NlmcpCallbackSolverData &solverData)
	Called when context constraint has been set and all data is valid.

Protected Member Functions inherited from agx::NlmcpCallback
	NlmcpCallback ()
	Default constructor.

virtual	~NlmcpCallback ()
	Protected destructor, reference counted object.

Protected Member Functions inherited from agx::Referenced
virtual	~Referenced ()
	Destructor.

void	allocateObserverVector () const

void	deleteUsingDeleteHandler () const

Additional Inherited Members
Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool	ValidateCast (const Referenced *object)

Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler *	getDeleteHandler ()

static void	setDeleteHandler (DeleteHandler *handler)
	Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.

Protected Attributes inherited from agx::Referenced
Mutex	m_mutex

ObserverContainer	m_observers

AtomicValue	m_refCount

Detailed Description

Constraint solver callback interface with context and start rows for context.

Definition at line 246 of file NlmcpCallback.h.

Constructor & Destructor Documentation

◆ ConstraintNlmcpCallback()

agx::ConstraintNlmcpCallback::ConstraintNlmcpCallback ( )

protected

◆ ~ConstraintNlmcpCallback()

virtual agx::ConstraintNlmcpCallback::~ConstraintNlmcpCallback ( )

protectedvirtual

Member Function Documentation

◆ getContext()

const ConstraintImplementation * agx::ConstraintNlmcpCallback::getContext ( ) const

Returns: constraint where this solver callback is used

◆ getContextDirectRow()

UInt agx::ConstraintNlmcpCallback::getContextDirectRow ( ) const

Returns: direct row of context constraint

◆ getContextIterativeRow()

UInt agx::ConstraintNlmcpCallback::getContextIterativeRow ( ) const

Returns: iterative row of context constraint

◆ onSetContext()

virtual void agx::ConstraintNlmcpCallback::onSetContext ( const NlmcpCallbackSolverData & solverData )

protectedvirtual

Called when context constraint has been set and all data is valid.

Parameters

solverData - solver related data our context is part of

Reimplemented in agx::FrictionControllerNlCallback.

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

NlmcpCallback.h

Public Member Functions

Protected Member Functions

Additional Inherited Members