Itasca C++ Interface
iclump.h
Go to the documentation of this file.
1 #pragma once
7 #include "base/src/farray.h"
8 
9 namespace itasca {
10  class IThing;
11  class IGroup;
12  class IContainer;
13 }
14 namespace itascaxd {
15  class IPiece;
16  class IPieceMechanical;
17  class IContact;
18  class IBody;
19  class IBodyMechanical;
20  class IRigidBodyMechanical;
21 }
22 
23 namespace pfc {
24  using namespace itasca;
25  using namespace itascaxd;
26  class IPebble;
27  class ITriPoly;
28  class IClumpTemplate;
29 
37  class IClump {
38  public:
40  inline static const TType type_ = 0x4e665ed6;
41 
43  virtual IThing * getIThing() = 0;
45  virtual const IThing * getIThing() const = 0;
47  virtual IClump * getNext() = 0;
49  virtual const IClump * getNext() const = 0;
51  virtual IPiece * getFirstIPiece() = 0;
53  virtual const IPiece * getFirstIPiece() const = 0;
55  virtual IPebble * getFirstPebble() = 0;
57  virtual const IPebble * getFirstPebble() const = 0;
59  virtual IPieceMechanical * getFirstIPieceMechanical() = 0;
61  virtual const IPieceMechanical * getFirstIPieceMechanical() const = 0;
63  virtual IBody * getIBody() = 0;
65  virtual const IBody * getIBody() const = 0;
67  virtual IBodyMechanical * getIBodyMechanical() = 0;
69  virtual const IBodyMechanical * getIBodyMechanical() const = 0;
71  virtual IRigidBodyMechanical * getIRigidBodyMechanical() = 0;
73  virtual const IRigidBodyMechanical *getIRigidBodyMechanical() const = 0;
74 
76  virtual uint32 getNumberPebbles() const=0;
78  virtual void getPebbleList(FArray<IPebble *> *)=0;
80  virtual void getPebbleList(FArray<const IPebble *> *) const=0;
82  virtual double getSurfaceScaleFactor() const = 0;
85  virtual double getMoiComp(int) const = 0;
88  virtual double getInertialMoiComp(int) const = 0;
89 #ifdef THREED
91  virtual SymTensor getInertialMoiTensor() const = 0;
92  virtual SymTensor getMoiTensor() const = 0;
93 #endif
95  virtual DAVect getMoi() const=0;
97  virtual DAVect getInertialMoi() const=0;
98 
100  virtual void setMoiComp(const double &,int) = 0;
102  virtual void setMoi(const DAVect &)=0;
103 
106  virtual bool rotate(const DVect &rotp,const DVect &axis,const double &w,bool update=true,bool noThrow = false) = 0;
108  virtual bool scale(const double &)=0;
109 
111  virtual void getContactList(FArray<IContact *> *ret,const TType &type=0,const IPiece *p2=0)=0;
113  virtual void getContactList(FArray<const IContact *> *ret,const TType &type=0,const IPiece *p2=0) const=0;
115  virtual uint64 getContactCount(bool active,const TType &type=0,bool domainToo = false) const=0;
116 
118  virtual IContainer *getClumpAsPebbleContainer() =0;
120  virtual const IContainer *getClumpAsPebbleContainer() const=0;
121 
123  virtual const ITriPoly * getSurfaceDescription() const=0;
124 
125 #ifdef THREED
127  virtual const Quat & getSurfaceOrientation() const=0;
128  virtual DVect getSurfaceEuler() const=0;
129 #else
131  virtual double getSurfaceOrientation() const=0;
132 #endif
133 
135  virtual void getSurfaceRotMatrix(DMatrix<dim,dim> *) const=0;
136 
138  virtual void removeIPebble(IPebble *,IContainer *)=0;
140  virtual IPebble *createAndAddPebble(const double &rad,const DVect &pos,IContainer *,uint64 id=0)=0;
141 
143  virtual IClumpTemplate * getMyClumpTemplate() =0;
145  virtual const IClumpTemplate * getMyClumpTemplate() const =0;
147  virtual void resetClumpTemplate()=0;
149  virtual bool getIsClumpTemplate() const=0;
150 
153  virtual void calcAndSetInertialAttributes(const double &per=0.01)=0;
154 
156  virtual void setMoiFix(bool b)=0;
157  virtual bool isMoiFix()=0;
158  virtual bool isMoiFix() const=0;
159 
161  virtual void setVolumeNoScale(const double &d)=0;
162 
164  virtual double getEnclosingDiameter() const=0;
165 
166  virtual int getFragmentIndex() const=0;
167 
168 
171  virtual bool getFix(uint32 dof) const=0;
173  virtual QString getFixLabel() const=0;
175  virtual QVariant getPieceProperty(const QString &name,const IPiece *p=0) const=0;
177  virtual double getDensity() const=0;
179  virtual double getInertialMass() const=0;
181  virtual double getMass() const=0;
183  virtual DVect getContactForce() const=0;
185  virtual DAVect getContactMoment() const=0;
187  virtual DVect getAppliedForce() const=0;
189  virtual DAVect getAppliedMoment() const=0;
191  virtual DVect getUnbalancedForce() const=0;
193  virtual DAVect getUnbalancedMoment() const=0;
195  virtual double getLocalDamping() const=0;
197  virtual void setFix(uint32 dof,bool b)=0;
199  virtual bool setPieceProperty(const QString &name,const QVariant &v,IPiece *p=0) =0;
201  virtual void setDensity(const double &d)=0;
203  virtual void setContactForce(const DVect &v)=0;
205  virtual void setContactMoment(const DAVect &v)=0;
207  virtual void setAppliedForce(const DVect &v)=0;
209  virtual void setAppliedMoment(const DAVect &v)=0;
211  virtual void setLocalDamping(const double &d)=0;
213  virtual void scaleVolumePreserveMass(const double &d,bool checkState=true,bool lock=false)=0;
214  virtual void setFragmentIndex(int ind)=0;
216  virtual bool getIsIn(const DVect &) const = 0;
217 
218 
220 #ifdef TWOD
221  virtual double getAngDisplacement() const=0;
222 #endif
223  virtual DVect getCentroid() const=0;
224  virtual DVect getVelocity() const=0;
225  virtual DAVect getAngVelocity() const=0;
226  virtual DVect getDisplacement() const=0;
227  virtual double getVolume() const=0;
228  virtual Quat getOrient() const=0;
229 
230 #ifdef TWOD
231  virtual void setAngDisplacement(const double &v)=0;
232 #endif
233  virtual void setCentroid(const DVect &p)=0;
234  virtual void setVelocity(const DVect &p)=0;
235  virtual void setAngVelocity(const DAVect &p)=0;
236  virtual void setDisplacement(const DVect &v)=0;
237  virtual void setOrient(const Quat &q)=0;
238 #ifdef THREED
239  virtual DVect getEulerFromOrient() const=0;
240  virtual void setOrientFromEuler(const DVect3 &d)=0;
241 #endif
242 
243 
244  };
245 } // namespace pfc
246 // EoF
DMatrix
DMatrix is a Matrix that defaults to type double...
Definition: matrix.h:741
FArray
An array class that attempts to minimize unnecessary heap access.
Definition: farray.h:25
Quat3
3D quaternion utility class.
Definition: quat.h:109
itasca::IContainer
Interface for containers of IThings.
Definition: icontainer.h:21
itasca::IThing
Base class for items that will be stored in containers.
Definition: ithing.h:30
itascaxd::IBody
Definition: ibody.h:20
itascaxd::IBodyMechanical
Definition: ibodymechanical.h:13
itascaxd::IPiece
Definition: ipiece.h:15
itascaxd::IPieceMechanical
Definition: ipiecemechanical.h:11
itascaxd::IRigidBodyMechanical
Definition: irigidbodymechanical.h:7
pfc::IClump
Interface for a clump. This is the interface for a clump. A clump is a collection of pebbles that def...
Definition: iclump.h:37
pfc::IClump::getIRigidBodyMechanical
virtual const IRigidBodyMechanical * getIRigidBodyMechanical() const =0
Return a const IRigidBodyMechanical pointer.
pfc::IClump::getNumberPebbles
virtual uint32 getNumberPebbles() const =0
Return the number of pebbles.
pfc::IClump::getIsClumpTemplate
virtual bool getIsClumpTemplate() const =0
Return true if part of a clump template.
pfc::IClump::getAppliedMoment
virtual DAVect getAppliedMoment() const =0
Return the applied moment.
pfc::IClump::calcAndSetInertialAttributes
virtual void calcAndSetInertialAttributes(const double &per=0.01)=0
pfc::IClump::getUnbalancedForce
virtual DVect getUnbalancedForce() const =0
Return the unbalanced force.
pfc::IClump::getFix
virtual bool getFix(uint32 dof) const =0
pfc::IClump::getContactList
virtual void getContactList(FArray< const IContact * > *ret, const TType &type=0, const IPiece *p2=0) const =0
Return a list of const IContacts.
pfc::IClump::getSurfaceRotMatrix
virtual void getSurfaceRotMatrix(DMatrix< dim, dim > *) const =0
Get the rotation matrix with reference to the clump template.
pfc::IClump::setDensity
virtual void setDensity(const double &d)=0
Set the density.
pfc::IClump::getInertialMass
virtual double getInertialMass() const =0
Return the inertial mass.
pfc::IClump::getMoi
virtual DAVect getMoi() const =0
Return the inertia tensor in principal axis form.
pfc::IClump::getSurfaceDescription
virtual const ITriPoly * getSurfaceDescription() const =0
Return the ITriPoly surface description of the clump.
pfc::IClump::getMass
virtual double getMass() const =0
Return the mass.
pfc::IClump::setVolumeNoScale
virtual void setVolumeNoScale(const double &d)=0
Set the volume without scaling the clump.
pfc::IClump::getMyClumpTemplate
virtual IClumpTemplate * getMyClumpTemplate()=0
Return the IClumpTemplate pointer.
pfc::IClump::getClumpAsPebbleContainer
virtual const IContainer * getClumpAsPebbleContainer() const =0
Return the const IContainer pointer of the ChildContainer corresponding to this clump.
pfc::IClump::getPebbleList
virtual void getPebbleList(FArray< const IPebble * > *) const =0
Return a list of pebbles.
pfc::IClump::getFirstIPieceMechanical
virtual IPieceMechanical * getFirstIPieceMechanical()=0
Return the first IPieceMechanical in this clump.
pfc::IClump::removeIPebble
virtual void removeIPebble(IPebble *, IContainer *)=0
Remove the pebble from the clump.
pfc::IClump::getPieceProperty
virtual QVariant getPieceProperty(const QString &name, const IPiece *p=0) const =0
Return the property of the piece.
pfc::IClump::getDensity
virtual double getDensity() const =0
Return the density.
pfc::IClump::getIBody
virtual const IBody * getIBody() const =0
Return a const IBody pointer.
pfc::IClump::setMoiComp
virtual void setMoiComp(const double &, int)=0
Set a component of the inertia tensor. Admissible values are: 11,12,13,22,23,33 in 3D.
pfc::IClump::getIBody
virtual IBody * getIBody()=0
Return an IBody pointer.
pfc::IClump::getAppliedForce
virtual DVect getAppliedForce() const =0
Return the applied force.
pfc::IClump::getIsIn
virtual bool getIsIn(const DVect &) const =0
Returns a boolean indicating whether a point in space is inside or outside of the ball.
pfc::IClump::getLocalDamping
virtual double getLocalDamping() const =0
Return the local damping coefficient.
pfc::IClump::createAndAddPebble
virtual IPebble * createAndAddPebble(const double &rad, const DVect &pos, IContainer *, uint64 id=0)=0
Add a pebble to this clump.
pfc::IClump::getCentroid
virtual DVect getCentroid() const =0
IRigidBodyMechanical interface.
pfc::IClump::getContactForce
virtual DVect getContactForce() const =0
Return the resultant of all contact forces.
pfc::IClump::getMoiComp
virtual double getMoiComp(int) const =0
pfc::IClump::getSurfaceScaleFactor
virtual double getSurfaceScaleFactor() const =0
Return the scale factor going from the clump to the surface representation.
pfc::IClump::setContactForce
virtual void setContactForce(const DVect &v)=0
Set the contact force.
pfc::IClump::getContactCount
virtual uint64 getContactCount(bool active, const TType &type=0, bool domainToo=false) const =0
Return the number of contacts.
pfc::IClump::getFirstPebble
virtual IPebble * getFirstPebble()=0
Return the first IPebble in this clump.
pfc::IClump::scaleVolumePreserveMass
virtual void scaleVolumePreserveMass(const double &d, bool checkState=true, bool lock=false)=0
Scale the volume to the specified value while preserving the mass.
pfc::IClump::getFirstIPiece
virtual IPiece * getFirstIPiece()=0
Return the first IPiece in this clump.
pfc::IClump::getPebbleList
virtual void getPebbleList(FArray< IPebble * > *)=0
Return a list of pebbles.
pfc::IClump::setAppliedMoment
virtual void setAppliedMoment(const DAVect &v)=0
Set the applied moment.
pfc::IClump::getEnclosingDiameter
virtual double getEnclosingDiameter() const =0
Calculate the diameter of the sphere enclosing the clump.
pfc::IClump::setAppliedForce
virtual void setAppliedForce(const DVect &v)=0
Set the applied force.
pfc::IClump::resetClumpTemplate
virtual void resetClumpTemplate()=0
Reset the clump template pointer.
pfc::IClump::setFix
virtual void setFix(uint32 dof, bool b)=0
Set the fixity condition.
pfc::IClump::setMoi
virtual void setMoi(const DAVect &)=0
Set the principal values of the inertia tensor directly.
pfc::IClump::scale
virtual bool scale(const double &)=0
Scale the clump to have this area or volume.
pfc::IClump::getNext
virtual const IClump * getNext() const =0
Return the next const IClump object in the global list, or 0 if it is the last set.
pfc::IClump::getNext
virtual IClump * getNext()=0
Return the next IClump object in the global list, or 0 if it is the last set.
pfc::IClump::setPieceProperty
virtual bool setPieceProperty(const QString &name, const QVariant &v, IPiece *p=0)=0
Set the property name.
pfc::IClump::getMyClumpTemplate
virtual const IClumpTemplate * getMyClumpTemplate() const =0
Return the const IClumpTemplate pointer.
pfc::IClump::setLocalDamping
virtual void setLocalDamping(const double &d)=0
Set the local damping coefficient.
pfc::IClump::getFirstIPieceMechanical
virtual const IPieceMechanical * getFirstIPieceMechanical() const =0
Return the first const IPieceMechanical in this clump.
pfc::IClump::getUnbalancedMoment
virtual DAVect getUnbalancedMoment() const =0
Return the unbalanced moment.
pfc::IClump::getClumpAsPebbleContainer
virtual IContainer * getClumpAsPebbleContainer()=0
Return the IContainer pointer of the ChildContainer corresponding to this clump.
pfc::IClump::getInertialMoiComp
virtual double getInertialMoiComp(int) const =0
pfc::IClump::setContactMoment
virtual void setContactMoment(const DAVect &v)=0
Set the contact moment.
pfc::IClump::getFirstIPiece
virtual const IPiece * getFirstIPiece() const =0
Return the first const IPiece in this clump.
pfc::IClump::setMoiFix
virtual void setMoiFix(bool b)=0
When setting the MOI from FISH one needs make sure that it is not reset no matter what.
pfc::IClump::getContactMoment
virtual DAVect getContactMoment() const =0
Return the resultant of all contact moments.
pfc::IClump::getIThing
virtual IThing * getIThing()=0
Return an IThing interface for this object.
pfc::IClump::getSurfaceOrientation
virtual double getSurfaceOrientation() const =0
Get the double corresponding to the orientation relative to the clump template orientation.
pfc::IClump::getFixLabel
virtual QString getFixLabel() const =0
Return a fixity label.
pfc::IClump::getIRigidBodyMechanical
virtual IRigidBodyMechanical * getIRigidBodyMechanical()=0
Return an IRigidBodyMechanical pointer.
pfc::IClump::getIThing
virtual const IThing * getIThing() const =0
Return a const IThing interface for this object.
pfc::IClump::rotate
virtual bool rotate(const DVect &rotp, const DVect &axis, const double &w, bool update=true, bool noThrow=false)=0
pfc::IClump::getIBodyMechanical
virtual IBodyMechanical * getIBodyMechanical()=0
Return an IBodyMechanical pointer.
pfc::IClump::getFirstPebble
virtual const IPebble * getFirstPebble() const =0
Return the first const IPebble in this clump.
pfc::IClump::getInertialMoi
virtual DAVect getInertialMoi() const =0
Return the inertial (may be scaled) inertia tensor in principal axis form.
pfc::IClump::getIBodyMechanical
virtual const IBodyMechanical * getIBodyMechanical() const =0
Return a const IBodyMechanical pointer.
pfc::IClump::getContactList
virtual void getContactList(FArray< IContact * > *ret, const TType &type=0, const IPiece *p2=0)=0
Return a list of IContacts.
pfc::IClumpTemplate
Interface for a clump template. This is the interface for a clump template. A clump template is compo...
Definition: iclumptemplate.h:25
pfc::IPebble
Definition: ipebble.h:25
pfc::ITriPoly
Interface for a TriPoly.
Definition: itripoly.h:39
farray.h
An array class that attempts to minimize unnecessary heap access.
TType
uint32 TType
class type indicator
Definition: basedef.h:46
DVect
DVect3 DVect
Vector of doubles, either 2D or 3D.
Definition: dim.h:150
DAVect
DAVect3 DAVect
Angular vector of doubles, either 2D or 3D.
Definition: dim.h:158
itasca
namespace Itasca
Definition: basememory.cpp:10
itascaxd
Itasca Library standard namespace, specific to 2D or 3D.
Definition: icontactmodule.h:4
pfc
PFC namespace.
Definition: iballfluid.h:15
Generated by doxygen 1.9.1