MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ChuteInsertionBoundary Class Reference

Used for modeling chute inflow. Inherits from InsertionBoundary. More...

#include <ChuteInsertionBoundary.h>

+ Inheritance diagram for ChuteInsertionBoundary:

Public Member Functions

 ChuteInsertionBoundary ()
 Default constructor. More...
 
 ChuteInsertionBoundary (const ChuteInsertionBoundary &other)
 Copy constructor. More...
 
ChuteInsertionBoundarycopy () const override
 Copy method; creates a copy on the heap. More...
 
void set (std::vector< BaseParticle * > particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, double fixedParticleRadius, double inflowVelocity, double inflowVelocityVariance)
 Sets all boundary properties at once. More...
 
void set (BaseParticle *particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, double fixedParticleRadius, double inflowVelocity, double inflowVelocityVariance)
 Sets all boundary properties at once. More...
 
void placeParticle (BaseParticle *p, RNG &random) override
 
void read (std::istream &is) override
 reads boundary properties from istream More...
 
void write (std::ostream &os) const override
 writes boundary properties to ostream More...
 
std::string getName () const override
 Returns the name of the object. More...
 
- Public Member Functions inherited from InsertionBoundary
 InsertionBoundary ()
 Defines a custom particle size distribution; distribution_ will always be used, unless particleSizeDistributionVector_ is non-empty. More...
 
 InsertionBoundary (const InsertionBoundary &other)
 Copy constructor (with deep copy) More...
 
 ~InsertionBoundary () override
 Destructor: delete the particle that has to be copied at every insertion. More...
 
virtual BaseParticlegenerateParticle (RNG &random)
 Sets the properties of the InsertionBoundary for mutliple different particle types. More...
 
void checkBoundaryBeforeTimeStep (DPMBase *md) override
 Fills the boundary with particles. More...
 
void insertParticles (DPMBase *md)
 Fill a certain domain with particles. More...
 
unsigned int getNumberOfParticlesInserted () const
 Gets the number of particles inserted by the boundary. More...
 
Mdouble getMassOfParticlesInserted () const
 Gets the mass of particles inserted by the boundary. More...
 
Mdouble getVolumeOfParticlesInserted () const
 Gets the volume of particles inserted by the boundary. More...
 
void reset ()
 resets particle property counter variables. More...
 
void activate ()
 Turns on the InsertionBoundary. More...
 
void deactivate ()
 Turns off the InsertionBoundary. More...
 
bool isActivated ()
 Returns whether the InsertionBoundary is activated. More...
 
unsigned int getMaxFailed () const
 Gets the number of times that the boundary may fail to insert a particle. More...
 
void setParticleToCopy (std::vector< BaseParticle * > particleToCopy)
 Sets multiple different particles that will be inserted through the insertion boundary. More...
 
void setParticleToCopy (BaseParticle *particleToCopy)
 Sets the particle that will be inserted through the insertion boundary. More...
 
std::vector< BaseParticle * > getParticleToCopy ()
 Gets the particles that will be inserted through the insertion boundary. More...
 
void read (std::istream &is) override
 Reads the boundary's id_ and maxFailed_. More...
 
void write (std::ostream &os) const override
 Writes the boundary's id_ and maxFailed_. More...
 
Mdouble getVolumeFlowRate () const
 Gets the volume flow rate of the insertion routine. More...
 
void setVolumeFlowRate (Mdouble volumeFlowRate_)
 Sets the volume flow rate of the insertion routine. More...
 
Mdouble getInitialVolume () const
 Gets the initialVolume() . More...
 
void setInitialVolume (Mdouble initialVolume)
 Gets the Volume which should be inserted by the insertion routine. More...
 
void setPSD (const PSD psd)
 Sets the range of particle radii that may be generated from a user defined PSD. More...
 
void setPSD (std::vector< PSD > psd, std::vector< Mdouble > probability)
 Sets the ranges of particle radii that may be generated from user defined PSDs. More...
 
std::vector< PSDgetPSD ()
 Gets the particle size distributions set by the user. More...
 
void setVariableVolumeFlowRate (const std::vector< Mdouble > &variableCumulativeVolumeFlowRate, Mdouble samplingInterval)
 Sets a variable volume flow rate. More...
 
bool insertParticle (Mdouble time)
 Checks the inserted total volume and returns if a particle is still allowed to be inserted. More...
 
bool getCheckParticleForInteraction () const
 Gets the variable that checks if a particle has an interaction. More...
 
void setCheckParticleForInteraction (bool checkParticleForInteraction)
 Sets the variable that checks if a particle has an interaction. More...
 
void setManualInsertion (bool manualInsertion)
 Set the flag for a manual PSD insertion routine. More...
 
- Public Member Functions inherited from BaseBoundary
 BaseBoundary ()
 default constructor. More...
 
 BaseBoundary (const BaseBoundary &b)
 copy constructor More...
 
 ~BaseBoundary () override
 destructor More...
 
virtual void createPeriodicParticle (BaseParticle *p UNUSED, ParticleHandler &pH UNUSED)
 Creates a periodic particle in case of periodic boundaries in serial build. More...
 
virtual void createPeriodicParticles (ParticleHandler &pH UNUSED)
 Creates periodic copies of given particle in case of periodic boundaries. More...
 
virtual void checkBoundaryAfterParticlesMove (ParticleHandler &pH)
 Virtual function that does things to particles, each time step after particles have moved. More...
 
virtual void actionsBeforeTimeLoop ()
 Virtual function that does something after DPMBase::setupInitialConditions but before the first time step. More...
 
virtual void modifyGhostAfterCreation (BaseParticle *particle, int i)
 
virtual void writeVTK (std::fstream &file)
 
void setHandler (BoundaryHandler *handler)
 Sets the boundary's BoundaryHandler. More...
 
BoundaryHandlergetHandler () const
 Returns the boundary's BoundaryHandler. More...
 
- Public Member Functions inherited from BaseObject
 BaseObject ()=default
 Default constructor. More...
 
 BaseObject (const BaseObject &p)=default
 Copy constructor, copies all the objects BaseObject contains. More...
 
virtual ~BaseObject ()=default
 virtual destructor More...
 
virtual void moveInHandler (unsigned int index)
 Except that it is virtual, it does the same thing as setIndex() does. More...
 
void setIndex (unsigned int index)
 Allows one to assign an index to an object in the handler/container. More...
 
void setId (unsigned long id)
 Assigns a unique identifier to each object in the handler (container) which remains constant even after the object is deleted from the container/handler. More...
 
unsigned int getIndex () const
 Returns the index of the object in the handler. More...
 
unsigned int getId () const
 Returns the unique identifier of any particular object. More...
 
void setGroupId (unsigned groupId)
 
unsigned getGroupId () const
 

Private Attributes

Vec3D posMin_
 The two extremal corners of the cuboidal insertion boundary. More...
 
Vec3D posMax_
 
double fixedParticleRadius_
 radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum randomly added/subtracted velocities in all three directions while generating particles (expressed as % of inflowVelocity_). NB: see also documentation of ChuteInsertionBoundary::generateParticle(). More...
 
double inflowVelocity_
 
double inflowVelocityVariance_
 

Additional Inherited Members

- Protected Attributes inherited from InsertionBoundary
std::vector< BaseParticle * > particleToCopy_
 write Distribution class to file. More...
 
unsigned int maxFailed_
 Number of times that the wall may fail to insert a particle. More...
 
unsigned int numberOfParticlesInserted_
 Number of particles that are already inserted. More...
 
Mdouble massInserted_
 Total mass of particles inserted. More...
 
Mdouble volumeInserted_
 Total volume of particles inserted. More...
 
bool isActivated_
 The InsertionBoundary is activated by default. If the InsertionBoundary is deactivated, then it introduces no particles (useful for trying to maintain a certain insertion rate). More...
 
Mdouble volumeFlowRate_
 
Mdouble initialVolume_
 
std::vector< MdoublevariableCumulativeVolumeFlowRate_
 
Mdouble samplingInterval_
 
bool checkParticleForInteraction_
 Checks if a particle has an interaction with a wall or other particles. More...
 
std::vector< PSDparticleSizeDistributionVector_
 Defines a particle size distribution as an object of the PSD class; if particleSizeDistributionVector_ is empty, distribution_ is used instead. More...
 
Vec3D velMin_
 Minimum and maximum velocity of the particles to be inserted. More...
 
Vec3D velMax_
 
bool isManuallyInserting_
 A flag to enable a top-down class-by-class manual insertion of a PSD; default is FALSE. More...
 
std::vector< Mdoubleprobability_
 vector of probabilities in range [0,1] which determine the mixing ratio of partice size distributions. More...
 

Detailed Description

Used for modeling chute inflow. Inherits from InsertionBoundary.

Definition at line 40 of file ChuteInsertionBoundary.h.

Constructor & Destructor Documentation

ChuteInsertionBoundary::ChuteInsertionBoundary ( )

Default constructor.

Default constructor. Initiates all properties with 0 value.

Definition at line 35 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, posMax_, and posMin_.

Referenced by copy().

36 {
37  posMax_ = Vec3D(0.0, 0.0, 0.0);
38  posMin_ = Vec3D(0.0, 0.0, 0.0);
40  inflowVelocity_ = 0.0;
42 }
InsertionBoundary()
Defines a custom particle size distribution; distribution_ will always be used, unless particleSizeDi...
double fixedParticleRadius_
radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum rand...
Vec3D posMin_
The two extremal corners of the cuboidal insertion boundary.
Definition: Vector.h:49
ChuteInsertionBoundary::ChuteInsertionBoundary ( const ChuteInsertionBoundary other)

Copy constructor.

Copy constructor. Calls InsertionBoundary parent copy constructor.

Definition at line 47 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, posMax_, and posMin_.

48  : InsertionBoundary(other)
49 {
50  posMax_ = other.posMax_;
51  posMin_ = other.posMin_;
55 }
InsertionBoundary()
Defines a custom particle size distribution; distribution_ will always be used, unless particleSizeDi...
double fixedParticleRadius_
radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum rand...
Vec3D posMin_
The two extremal corners of the cuboidal insertion boundary.

Member Function Documentation

ChuteInsertionBoundary * ChuteInsertionBoundary::copy ( ) const
overridevirtual

Copy method; creates a copy on the heap.

Copy method. Creates a copy on the heap.

Returns
Pointer to the copy.

Implements BaseBoundary.

Definition at line 61 of file ChuteInsertionBoundary.cc.

References ChuteInsertionBoundary().

62 {
63 #ifdef DEBUG_CONSTRUCTOR
64  std::cout << "ChuteInsertionBoundary::copy() const finished" << std::endl;
65 #endif
66  return new ChuteInsertionBoundary(*this);
67 }
ChuteInsertionBoundary()
Default constructor.
std::string ChuteInsertionBoundary::getName ( ) const
overridevirtual

Returns the name of the object.

Returns the name of the object class

Returns
the object's class' name, i.e. 'ChuteInsertionBoundary'

Implements BaseObject.

Definition at line 210 of file ChuteInsertionBoundary.cc.

211 {
212  return "ChuteInsertionBoundary";
213 }
void ChuteInsertionBoundary::placeParticle ( BaseParticle p,
RNG random 
)
overridevirtual

place a particle within the boundary with random radius, position and velocity (within the allowed intervals). Notable properties:

  • The minimal Z-position is fixedParticleRadius_ (the radius of the particles fixed at the bottom) above the minimal Z-value of the boundary
  • The particles have an mean velocity of inflowVelocity_ in the X-direction. Furthermore, each particle has a velocity added in all three directions, based on a given inflowVelocityVariance_, which is expressed as a percentage of the inflowVelocity_.
    Parameters
    [in]randoma random number generator
    Returns
    pointer to the generated particle
Todo:
change to driver level (ask Thomas)

Implements InsertionBoundary.

Definition at line 148 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, BaseParticle::getRadius(), RNG::getRandomNumber(), inflowVelocity_, inflowVelocityVariance_, posMax_, posMin_, BaseInteractable::setPosition(), BaseInteractable::setVelocity(), Vec3D::X, Vec3D::Y, and Vec3D::Z.

149 {
150  Vec3D position, velocity;
151 
152  position.X = posMin_.X + p->getRadius();
153 
155 // if (mathsFunc::isEqual(posMax_.Y - posMin_.Y, 2.0 * radMax_, 1e-10))
156 // {
157 // position.Y = posMin_.Y + p->getRadius();
158 // }
159 
160  position.Y = random.getRandomNumber(posMin_.Y - p->getRadius(), posMax_.Y + p->getRadius());
161  position.Z = random.getRandomNumber(posMin_.Z - p->getRadius(), posMax_.Z + p->getRadius() + fixedParticleRadius_);
162 
163  // The velocity components are first stored in a Vec3D, because if you pass them
164  // directly into setVelocity the compiler is allowed to change the order in
165  // which the numbers are generated
170 
171  p->setPosition(position);
172  p->setVelocity(velocity);
173 
174 
175 }
Mdouble X
the vector components
Definition: Vector.h:65
void setVelocity(const Vec3D &velocity)
set the velocity of the BaseInteractable.
Mdouble getRandomNumber()
This is a random generating routine can be used for initial positions.
Definition: RNG.cc:143
double fixedParticleRadius_
radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum rand...
Vec3D posMin_
The two extremal corners of the cuboidal insertion boundary.
Mdouble getRadius() const
Returns the particle's radius.
Definition: BaseParticle.h:348
Mdouble Y
Definition: Vector.h:65
void setPosition(const Vec3D &position)
Sets the position of this BaseInteractable.
Definition: Vector.h:49
Mdouble Z
Definition: Vector.h:65
void ChuteInsertionBoundary::read ( std::istream &  is)
overridevirtual

reads boundary properties from istream

Reads the boundary properties from an istream

Parameters
[in,out]isthe istream

Implements BaseBoundary.

Definition at line 181 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, posMax_, posMin_, and InsertionBoundary::read().

182 {
184  std::string dummy;
185  is >> dummy >> posMin_
186  >> dummy >> posMax_
187  >> dummy >> fixedParticleRadius_
188  >> dummy >> inflowVelocity_
189  >> dummy >> inflowVelocityVariance_;
190 }
double fixedParticleRadius_
radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum rand...
Vec3D posMin_
The two extremal corners of the cuboidal insertion boundary.
void read(std::istream &is) override
Reads the boundary's id_ and maxFailed_.
void ChuteInsertionBoundary::set ( std::vector< BaseParticle * >  particleToCopy,
unsigned int  maxFailed,
Vec3D  posMin,
Vec3D  posMax,
double  fixedParticleRadius,
double  inflowVelocity,
double  inflowVelocityVariance 
)

Sets all boundary properties at once.

Sets all the properties of the chute insertion boundary.

Parameters
[in]particleToCopyvector of pointers to the BaseParticles which are used as a basis for the particles to be inserted
[in]maxFailedThe maximum number of times the insertion of a particle may be tried and failed before the insertion of particles is considered done. NB: this property is used in the parent's InsertionBoundary::checkBoundaryBeforeTimeStep().
[in]posMinFirst defining corner of the chute insertion boundary
[in]posMaxSecond defining corner of the chute insertion boundary
[in]fixedParticleRadiusradius of the fixed bottom (i.e., positioned at the minimal Z-position) particles
[in]inflowVelocitythe mean particle velocity, which is in the X-direction
[in]inflowVelocityVariancevalue of minimum (minus ~) and maximum added velocities which are added to the given mean in each of the three dimensions. Expressed as a percentage of inflowVelocity_. See also the documentation of ChuteInsertionBoundary::generateParticle().

Definition at line 89 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, InsertionBoundary::maxFailed_, posMax_, posMin_, and InsertionBoundary::setParticleToCopy().

Referenced by Chute::setupInitialConditions().

92 {
93  setParticleToCopy(particleToCopy);
94  posMin_ = posMin;
95  posMax_ = posMax;
96  maxFailed_ = maxFailed;
97  fixedParticleRadius_ = fixedParticleRadius;
98  inflowVelocity_ = inflowVelocity;
99  inflowVelocityVariance_ = inflowVelocityVariance;
100 }
unsigned int maxFailed_
Number of times that the wall may fail to insert a particle.
double fixedParticleRadius_
radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum rand...
void setParticleToCopy(std::vector< BaseParticle * > particleToCopy)
Sets multiple different particles that will be inserted through the insertion boundary.
Vec3D posMin_
The two extremal corners of the cuboidal insertion boundary.
void ChuteInsertionBoundary::set ( BaseParticle particleToCopy,
unsigned int  maxFailed,
Vec3D  posMin,
Vec3D  posMax,
double  fixedParticleRadius,
double  inflowVelocity,
double  inflowVelocityVariance 
)

Sets all boundary properties at once.

Sets all the properties of the chute insertion boundary.

Parameters
[in]particleToCopyPointer to the BaseParticle which is used as a basis for the particles to be inserted
[in]maxFailedThe maximum number of times the insertion of a particle may be tried and failed before the insertion of particles is considered done. NB: this property is used in the parent's InsertionBoundary::checkBoundaryBeforeTimeStep().
[in]posMinFirst defining corner of the chute insertion boundary
[in]posMaxSecond defining corner of the chute insertion boundary
[in]fixedParticleRadiusradius of the fixed bottom (i.e., positioned at the minimal Z-position) particles
[in]inflowVelocitythe mean particle velocity, which is in the X-direction
[in]inflowVelocityVariancevalue of minimum (minus ~) and maximum added velocities which are added to the given mean in each of the three dimensions. Expressed as a percentage of inflowVelocity_. See also the documentation of ChuteInsertionBoundary::generateParticle().

Definition at line 122 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, InsertionBoundary::maxFailed_, posMax_, posMin_, and InsertionBoundary::setParticleToCopy().

125 {
126  setParticleToCopy(particleToCopy);
127  posMin_ = posMin;
128  posMax_ = posMax;
129  maxFailed_ = maxFailed;
130  fixedParticleRadius_ = fixedParticleRadius;
131  inflowVelocity_ = inflowVelocity;
132  inflowVelocityVariance_ = inflowVelocityVariance;
133 }
unsigned int maxFailed_
Number of times that the wall may fail to insert a particle.
double fixedParticleRadius_
radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum rand...
void setParticleToCopy(std::vector< BaseParticle * > particleToCopy)
Sets multiple different particles that will be inserted through the insertion boundary.
Vec3D posMin_
The two extremal corners of the cuboidal insertion boundary.
void ChuteInsertionBoundary::write ( std::ostream &  os) const
overridevirtual

writes boundary properties to ostream

Writes boundary's properties to an ostream

Parameters
[in]osthe ostream

Implements BaseBoundary.

Definition at line 196 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, posMax_, posMin_, and InsertionBoundary::write().

197 {
199  os << " posMin " << posMin_
200  << " posMax " << posMax_
201  << " fixedParticleRadius " << fixedParticleRadius_
202  << " inflowVelocity " << inflowVelocity_
203  << " inflowVelocityVariance " << inflowVelocityVariance_;
204 }
double fixedParticleRadius_
radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum rand...
Vec3D posMin_
The two extremal corners of the cuboidal insertion boundary.
void write(std::ostream &os) const override
Writes the boundary's id_ and maxFailed_.

Member Data Documentation

double ChuteInsertionBoundary::fixedParticleRadius_
private

radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum randomly added/subtracted velocities in all three directions while generating particles (expressed as % of inflowVelocity_). NB: see also documentation of ChuteInsertionBoundary::generateParticle().

Definition at line 100 of file ChuteInsertionBoundary.h.

Referenced by ChuteInsertionBoundary(), placeParticle(), read(), set(), and write().

double ChuteInsertionBoundary::inflowVelocity_
private

Definition at line 100 of file ChuteInsertionBoundary.h.

Referenced by ChuteInsertionBoundary(), placeParticle(), read(), set(), and write().

double ChuteInsertionBoundary::inflowVelocityVariance_
private

Definition at line 100 of file ChuteInsertionBoundary.h.

Referenced by ChuteInsertionBoundary(), placeParticle(), read(), set(), and write().

Vec3D ChuteInsertionBoundary::posMax_
private

Definition at line 92 of file ChuteInsertionBoundary.h.

Referenced by ChuteInsertionBoundary(), placeParticle(), read(), set(), and write().

Vec3D ChuteInsertionBoundary::posMin_
private

The two extremal corners of the cuboidal insertion boundary.

Definition at line 92 of file ChuteInsertionBoundary.h.

Referenced by ChuteInsertionBoundary(), placeParticle(), read(), set(), and write().


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