Jive reference manual
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Friends
jive::util::Constraints Class Reference

#include <jive/util/Constraints.h>

Inheritance diagram for jive::util::Constraints:
Inheritance graph

Public Types

enum  Kind {
  COMPRESSED,
  SIMPLE,
  COMPLEX
}
 

Public Member Functions

 Constraints ()
 
 Constraints (const Ref< DofSpace > &dofs, Kind kind=SIMPLE)
 
 Constraints (const Self &rhs)
 
virtual String toString () const
 Returns a short textual description of this object. More...
 
virtual void resetEvents ()
 
virtual void readFrom (ObjectInput &in)
 
virtual void writeTo (ObjectOutput &out) const
 
virtual Ref< Objectclone () const
 
void copy (const Constraints &rhs)
 
void clear ()
 
void reserve (idx_t slaveCount)
 
void compress ()
 
void trimToSize ()
 
idx_t dofCount () const
 
idx_t slaveDofCount () const
 
idx_t masterDofCount () const
 
idx_t masterDofCount (idx_t idof) const
 
bool isSlaveDof (idx_t idof) const
 
IdxVector getSlaveDofs () const
 
idx_t getSlaveDofs (const IdxVector &idofs) const
 
bool isMasterDof (idx_t jdof) const
 
idx_t getMasterDofs (const IdxVector &jdofs, idx_t idof) const
 
bool hasRvalue (idx_t idof) const
 
void addConstraint (idx_t idof)
 
void addConstraint (idx_t idof, double rval)
 
void addConstraint (idx_t idof, idx_t jdof, double coeff)
 
void addConstraint (idx_t idof, double rval, idx_t jdof, double coeff)
 
void addConstraint (idx_t idof, const IdxVector &jdofs, const Vector &coeffs)
 
void addConstraint (idx_t idof, double rval, const IdxVector &jdofs, const Vector &coeffs)
 
void setConstraints (const SparseMatrix &conmat)
 
void setConstraints (const SparseMatrix &conmat, const BoolVector &rmask)
 
bool eraseConstraint (idx_t idof)
 
idx_t eraseConstraints (const IdxVector &idofs)
 
idx_t getConstraint (double &rval, const IdxVector &jdofs, const Vector &coeffs, idx_t idof) const
 
void setRvalue (idx_t idof, double rval)
 
void setRvalues (const IdxVector &idofs, const Vector &rvals)
 
void unsetRvalue (idx_t idof)
 
void unsetRvalues (const IdxVector &idofs)
 
double getRvalue (idx_t idof) const
 
void getRvalues (const Vector &rvals, const IdxVector &idofs) const
 
void getRvalues (const SparseMatrix &cmat) const
 
void getRvalueMask (const BoolVector &rmask, const IdxVector &idofs) const
 
SparseMatrix toMatrix () const
 
DofSpacegetDofSpace () const
 
void printTo (PrintWriter &out) const
 
void store (const Properties &globdat) const
 
- Public Member Functions inherited from jem::Object
virtual ClassgetClass () const
 Returns the Class instance representing the runtime class of this object. More...
 
virtual long hashValue () const
 Returns a hash value for this object. More...
 
virtual bool equals (const Ref< Object > &obj) const
 Tests whether two objects are equal. More...
 
Ref< Objectclone () const
 Returns a copy of this object. More...
 

Static Public Member Functions

static Ref< Self > find (const Ref< DofSpace > &dofs, const Properties &globdat)
 
static Ref< Self > extract (const Ref< DofSpace > &dofs, const Properties &globdat)
 
static Ref< Self > get (const Ref< DofSpace > &dofs, const Properties &globdat)
 
- Static Public Member Functions inherited from jem::Object
static ClassgetType ()
 Returns the Class instance representing the Object class. More...
 

Public Attributes

Event< Self & > newStructEvent
 
Event< Self & > newRvaluesEvent
 

Static Public Attributes

static const char * KIND_NAMES []
 

Protected Member Functions

virtual ~Constraints ()
 
virtual void emitEvents_ (int events)
 
- Protected Member Functions inherited from jem::Collectable
 Collectable ()
 Creates an empty Collectable. More...
 
 ~Collectable ()
 Frees resources. More...
 
- Protected Member Functions inherited from jive::util::EventSource
virtual ~EventSource ()
 
- Protected Member Functions inherited from jem::Interface
virtual ~Interface ()
 Empty destructor. More...
 
- Protected Member Functions inherited from jem::Clonable
virtual ~Clonable ()
 
virtual void emitVTable_ ()
 
- Protected Member Functions inherited from jem::io::Serializable
virtual ~Serializable ()
 
virtual void emitVtableFunc_ ()
 

Friends

void setSlaveDofs (const Vector &vec, const Constraints &cons)
 
void setSlaveDofs (const Vector &vec, const Constraints &cons, double rscale)
 
void zeroSlaveDofs (const Vector &vec, const Constraints &cons)
 
void evalSlaveDofs (const Vector &vec, const Constraints &cons)
 
void evalSlaveDofs (const Vector &vec, const Constraints &cons, double rscale)
 
void evalMasterDofs (const Vector &vec, const Constraints &cons)
 

Member Enumeration Documentation

Enumerator
COMPRESSED 
SIMPLE 
COMPLEX 

Constructor & Destructor Documentation

jive::util::Constraints::Constraints ( )
jive::util::Constraints::Constraints ( const Ref< DofSpace > &  dofs,
Kind  kind = SIMPLE 
)
explicit
jive::util::Constraints::Constraints ( const Self &  rhs)
virtual jive::util::Constraints::~Constraints ( )
protectedvirtual

Member Function Documentation

virtual String jive::util::Constraints::toString ( ) const
virtual

Returns a short textual description of this object. The toString method of the class Object returns:

getClass()->getName() + "@" + String( hashValue() )

Returns
A String representing this object.

Reimplemented from jem::Object.

virtual void jive::util::Constraints::resetEvents ( )
virtual
virtual void jive::util::Constraints::readFrom ( ObjectInput in)
virtual

Implements jem::io::Serializable.

virtual void jive::util::Constraints::writeTo ( ObjectOutput out) const
virtual

Implements jem::io::Serializable.

virtual Ref<Object> jive::util::Constraints::clone ( ) const
virtual

Implements jem::Clonable.

void jive::util::Constraints::copy ( const Constraints rhs)
void jive::util::Constraints::clear ( )
void jive::util::Constraints::reserve ( idx_t  slaveCount)
void jive::util::Constraints::compress ( )
void jive::util::Constraints::trimToSize ( )
idx_t jive::util::Constraints::dofCount ( ) const
idx_t jive::util::Constraints::slaveDofCount ( ) const
idx_t jive::util::Constraints::masterDofCount ( ) const
idx_t jive::util::Constraints::masterDofCount ( idx_t  idof) const
bool jive::util::Constraints::isSlaveDof ( idx_t  idof) const
IdxVector jive::util::Constraints::getSlaveDofs ( ) const
idx_t jive::util::Constraints::getSlaveDofs ( const IdxVector &  idofs) const
bool jive::util::Constraints::isMasterDof ( idx_t  jdof) const
idx_t jive::util::Constraints::getMasterDofs ( const IdxVector &  jdofs,
idx_t  idof 
) const
bool jive::util::Constraints::hasRvalue ( idx_t  idof) const
void jive::util::Constraints::addConstraint ( idx_t  idof)
void jive::util::Constraints::addConstraint ( idx_t  idof,
double  rval 
)
void jive::util::Constraints::addConstraint ( idx_t  idof,
idx_t  jdof,
double  coeff 
)
void jive::util::Constraints::addConstraint ( idx_t  idof,
double  rval,
idx_t  jdof,
double  coeff 
)
void jive::util::Constraints::addConstraint ( idx_t  idof,
const IdxVector &  jdofs,
const Vector coeffs 
)
void jive::util::Constraints::addConstraint ( idx_t  idof,
double  rval,
const IdxVector &  jdofs,
const Vector coeffs 
)
void jive::util::Constraints::setConstraints ( const SparseMatrix &  conmat)
void jive::util::Constraints::setConstraints ( const SparseMatrix &  conmat,
const BoolVector rmask 
)
bool jive::util::Constraints::eraseConstraint ( idx_t  idof)
idx_t jive::util::Constraints::eraseConstraints ( const IdxVector &  idofs)
idx_t jive::util::Constraints::getConstraint ( double &  rval,
const IdxVector &  jdofs,
const Vector coeffs,
idx_t  idof 
) const
void jive::util::Constraints::setRvalue ( idx_t  idof,
double  rval 
)
void jive::util::Constraints::setRvalues ( const IdxVector &  idofs,
const Vector rvals 
)
void jive::util::Constraints::unsetRvalue ( idx_t  idof)
void jive::util::Constraints::unsetRvalues ( const IdxVector &  idofs)
double jive::util::Constraints::getRvalue ( idx_t  idof) const
void jive::util::Constraints::getRvalues ( const Vector rvals,
const IdxVector &  idofs 
) const
void jive::util::Constraints::getRvalues ( const SparseMatrix &  cmat) const
void jive::util::Constraints::getRvalueMask ( const BoolVector rmask,
const IdxVector &  idofs 
) const
SparseMatrix jive::util::Constraints::toMatrix ( ) const
DofSpace * jive::util::Constraints::getDofSpace ( ) const
void jive::util::Constraints::printTo ( PrintWriter out) const
void jive::util::Constraints::store ( const Properties globdat) const
static Ref<Self> jive::util::Constraints::find ( const Ref< DofSpace > &  dofs,
const Properties globdat 
)
static
static Ref<Self> jive::util::Constraints::extract ( const Ref< DofSpace > &  dofs,
const Properties globdat 
)
static
static Ref<Self> jive::util::Constraints::get ( const Ref< DofSpace > &  dofs,
const Properties globdat 
)
static
virtual void jive::util::Constraints::emitEvents_ ( int  events)
protectedvirtual

Friends And Related Function Documentation

void setSlaveDofs ( const Vector vec,
const Constraints cons 
)
friend
void setSlaveDofs ( const Vector vec,
const Constraints cons,
double  rscale 
)
friend
void zeroSlaveDofs ( const Vector vec,
const Constraints cons 
)
friend
void evalSlaveDofs ( const Vector vec,
const Constraints cons 
)
friend
void evalSlaveDofs ( const Vector vec,
const Constraints cons,
double  rscale 
)
friend
void evalMasterDofs ( const Vector vec,
const Constraints cons 
)
friend

Member Data Documentation

const char* jive::util::Constraints::KIND_NAMES[]
static
Event< Self& > jive::util::Constraints::newStructEvent
Event< Self& > jive::util::Constraints::newRvaluesEvent