Jive reference manual
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
jive::util::XDofSpace Class Referenceabstract

#include <jive/util/XDofSpace.h>

Inheritance diagram for jive::util::XDofSpace:
Inheritance graph

Public Member Functions

virtual void clearDofs ()=0
 
virtual void clearAll ()=0
 
virtual void reserve (idx_t dofCount)
 
virtual void trimToSize ()
 
virtual idx_t addType (const String &name)=0
 
virtual IdxVector addTypes (const StringVector &names)
 
virtual idx_t addDof (idx_t iitem, idx_t itype)=0
 
virtual void addDofs (const IdxVector &iitems, const IdxVector &itypes)
 
void addDofs (idx_t iitem, const IdxVector &itypes)
 
void addDofs (const IdxVector &iitems, idx_t itype)
 
void eraseDofs (const IdxVector &idofs)
 
virtual void reorderDofs (const Reordering &reord)=0
 
- Public Member Functions inherited from jive::util::DofSpace
int itemCount () const
 Returns the size of the item set associated with this dof space. More...
 
virtual int typeCount () const =0
 Returns the number of dof types. More...
 
virtual int dofCount () const =0
 Returns the total number of dofs. More...
 
virtual int findType (const String &name) const
 Searches for a dof type with a given name. More...
 
virtual String getTypeName (int itype) const =0
 Returns a name of a dof type with a given index. More...
 
virtual StringVector getTypeNames () const
 Returns a array containing all dof type names. More...
 
virtual int findDofIndex (int iitem, int itype) const =0
 Searches for a dof attached to a given item. More...
 
int getDofIndex (int iitem, int itype) const
 Returns the index of a dof attached to a given item. More...
 
virtual int findDofIndices (const IntVector &idofs, const IntVector &iitems, const IntVector &itypes) const
 Searches for the dofs attached to a given set of items. More...
 
virtual int collectDofIndices (const IntVector &idofs, const IntVector &iitems, const IntVector &itypes) const
 Collects the indices of the dofs attached to a given set of items. More...
 
void getDofIndices (const IntVector &idofs, const IntVector &iitems, const IntVector &itypes) const
 Gets the indices of the dofs attached to a given set of items. More...
 
virtual int getDofsForItem (const IntVector &idofs, const IntVector &itypes, int iitem) const
 Returns all dofs attached to a given item. More...
 
virtual int getDofsForType (const IntVector &idofs, const IntVector &iitems, int itype) const
 Returns all dofs of a given type. More...
 
virtual void decodeDofIndex (int &iitem, int &itype, int idof) const =0
 Returns an item/type index pair given a dof index. More...
 
virtual void decodeDofIndices (const IntVector &iitems, const IntVector &itypes, const IntVector &idofs) const
 Returns item/type index pairs given a set of dof indices. More...
 
virtual SparseMatrix toMatrix () const =0
 Returns a matrix representation of this dof space. More...
 
virtual ItemSetgetItems () const =0
 Returns the item set associated with this dof space. More...
 
String getDofPath (int idof) const
 Returns an identification string for a given dof. More...
 
String getDofPath (int iitem, int itype) const
 Returns an identification string for a given dof. More...
 
String getContext () const
 Returns a context string. More...
 
void printTo (jem::io::TextOutput &out) const
 Writes the state of this dof space to a text output stream. More...
 
void store (const Properties &globdat) const
 Stores this dof space in a (global) data set. More...
 
virtual String toString () const
 Returns a short textual description of this object. More...
 
- 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< XDofSpacefind (const Properties &globdat)
 
static Ref< XDofSpacefind (const Ref< ItemSet > &items, const Properties &globdat)
 
static Ref< XDofSpaceget (const Properties &globdat, const String &context)
 
static Ref< XDofSpaceget (const Ref< ItemSet > &items, const Properties &globdat)
 
- Static Public Member Functions inherited from jive::util::DofSpace
static jem::Ref< DofSpacefind (const Properties &globdat)
 Searches for the primary dof space in a (global) data set. More...
 
static jem::Ref< DofSpacefind (const jem::Ref< ItemSet > &items, const Properties &globdat)
 Searches for an item-specific dof space in a (global) data set. More...
 
static jem::Ref< DofSpaceget (const Properties &globdat, const String &context)
 Returns the primary dof space in a (global) data set. More...
 
static jem::Ref< DofSpaceget (const jem::Ref< ItemSet > &items, const Properties &globdat, const String &context)
 Returns an item-specific dof space in a (global) data set. More...
 
- Static Public Member Functions inherited from jem::Object
static ClassgetType ()
 Returns the Class instance representing the Object class. More...
 

Protected Member Functions

virtual ~XDofSpace ()
 
- Protected Member Functions inherited from jive::util::DofSpace
virtual ~DofSpace ()
 
- Protected Member Functions inherited from jem::Collectable
 Collectable ()
 Creates an empty Collectable. More...
 
 ~Collectable ()
 Frees resources. More...
 

Additional Inherited Members

- Public Types inherited from jive::util::DofSpace
typedef jem::String String
 Represents a string type. More...
 
typedef jem::numeric::SparseMatrix< int > SparseMatrix
 Represents a sparse integer matrix. More...
 
typedef jem::util::Properties Properties
 Represents a properties set. More...
 
- Public Attributes inherited from jive::util::DofSpace
jem::util::Event< int, Self & > newSizeEvent
 Signals that the number of dofs has changed. More...
 
jem::util::Event< const IntVector &, Self & > newOrderEvent
 Signals that the dofs have been re-ordered. More...
 

Constructor & Destructor Documentation

virtual jive::util::XDofSpace::~XDofSpace ( )
protectedvirtual

Member Function Documentation

virtual void jive::util::XDofSpace::clearDofs ( )
pure virtual
virtual void jive::util::XDofSpace::clearAll ( )
pure virtual
virtual void jive::util::XDofSpace::reserve ( idx_t  dofCount)
virtual
virtual void jive::util::XDofSpace::trimToSize ( )
virtual
virtual idx_t jive::util::XDofSpace::addType ( const String name)
pure virtual
virtual IdxVector jive::util::XDofSpace::addTypes ( const StringVector names)
virtual
virtual idx_t jive::util::XDofSpace::addDof ( idx_t  iitem,
idx_t  itype 
)
pure virtual
virtual void jive::util::XDofSpace::addDofs ( const IdxVector &  iitems,
const IdxVector &  itypes 
)
virtual
void jive::util::XDofSpace::addDofs ( idx_t  iitem,
const IdxVector &  itypes 
)
void jive::util::XDofSpace::addDofs ( const IdxVector &  iitems,
idx_t  itype 
)
void jive::util::XDofSpace::eraseDofs ( const IdxVector &  idofs)
virtual void jive::util::XDofSpace::reorderDofs ( const Reordering reord)
pure virtual
static Ref<XDofSpace> jive::util::XDofSpace::find ( const Properties globdat)
static
static Ref<XDofSpace> jive::util::XDofSpace::find ( const Ref< ItemSet > &  items,
const Properties globdat 
)
static
static Ref<XDofSpace> jive::util::XDofSpace::get ( const Properties globdat,
const String context 
)
static
static Ref<XDofSpace> jive::util::XDofSpace::get ( const Ref< ItemSet > &  items,
const Properties globdat 
)
static