Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

[detail level 123456]

►CAdhesiveForceInteraction
CInteraction< NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction >	Contains information about the contact between two interactables, BaseInteraction::P_ and BaseInteraction::I_;
►CAdhesiveForceSpecies	Defines a short-range (non-contact) force parallel to the contact normal, usually adhesive
CMixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >	Contains contact force properties for contacts between particles with two different species
CSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >	Contains material and contact force properties
CAngledPerioidicBoundary	Defines a pair of periodic walls that are angled around the origin
CNurbsUtils::array2< T >	A simple class for representing 2D runtime arrays
►CCGCoordinates::BaseCoordinates	Contains common member functions of the X, Y, and Z classes
►CCGCoordinates::Base_X_Y_Z	Contains common member functions of the X, Y, and Z classes
CCGCoordinates::R	Defines the non-averaged directions on which spatial coarse-graining is applied (the x-direction for R); all other directions are averaged over homogeneously
CCGCoordinates::X	Defines the non-averaged directions on which spatial coarse-graining is applied (the x-direction for X); all other directions are averaged over homogeneously
CCGCoordinates::Y	Defines the non-averaged directions on which spatial coarse-graining is applied (the y- direction for Y); all other directions are averaged over homogeneously
CCGCoordinates::Z	Defines the non-averaged directions on which spatial coarse-graining is applied (the z-direction for Z); all other directions are averaged over homogeneously
►CCGCoordinates::Base_XY_XZ_YZ	Contains common member functions of the XY, XZ, and YZ classes
CCGCoordinates::RZ	Defines the non-averaged directions on which spatial coarse-graining is applied (the x- and z-direction for RZ); all other directions are averaged over homogeneously
CCGCoordinates::XY	Defines the non-averaged directions on which spatial coarse-graining is applied (the x- and y-direction for XY); all other directions are averaged over homogeneously
CCGCoordinates::XZ	Defines the non-averaged directions on which spatial coarse-graining is applied (the x- and z-direction for XZ); all other directions are averaged over homogeneously
CCGCoordinates::YZ	Defines the non-averaged directions on which spatial coarse-graining is applied (the y- and z-direction for YZ); all other directions are averaged over homogeneously
CCGCoordinates::O	Defines the non-averaged directions on which spatial coarse-graining is applied (none for O); all other directions (all for O) are averaged over homogeneously
CCGCoordinates::XYZ	Defines the position of the CGPoint, in the non-averaged directions, i.e. all directions on which spatial coarse-graining is applied (all directions for XYZ); all other directions are averaged over homogeneously
►CBaseForce
►CBaseAdhesiveForce
CBondedSpecies	BondedSpecies contains the parameters used to describe a linear irreversible short-range force
CChargedBondedSpecies	ChargedBondedSpecies contains the parameters used to describe a linear reversible short-range force
CEmptyAdhesiveSpecies	EmptyAdhesiveSpecies is used to create a force law without a short-range adhesive force
CLiquidBridgeWilletSpecies	LiquidBridgeWilletSpecies contains the parameters used to describe a short-range force caused by liquid bridges
CLiquidMigrationWilletSpecies	LiquidMigrationWilletSpecies contains the parameters used to describe a short-range force caused by liquid bridges
CParhamiMcMeekingSinterSpecies	ParhamiMcMeekingSinterSpecies contains the parameters used to describe a linear reversible short-range force
CRegimeSinterSpecies	RegimeSinterSpecies contains the parameters used to describe the sintering of particles following three different mechanisms
►CReversibleAdhesiveSpecies	ReversibleAdhesiveSpecies contains the parameters used to describe a linear reversible short-range force
CIrreversibleAdhesiveSpecies	IrreversibleAdhesiveSpecies contains the parameters used to describe a linear irreversible short-range force
►CBaseFrictionForce
CEmptyFrictionSpecies	EmptyFrictionSpecies is used to create a force law without frictional forces
►CMindlinSpecies	MindlinSpecies contains the parameters used to describe sliding friction
CMindlinRollingTorsionSpecies	MindlinRollingTorsionSpecies contains the parameters used to describe sliding, rolling and torsional friction
►CSlidingFrictionSpecies	SlidingFrictionSpecies contains the parameters used to describe sliding friction
CFrictionSpecies	FrictionSpecies contains the parameters used to describe sliding, rolling and torsional friction
►CBaseNormalForce
CHertzianSinterNormalSpecies	HertzianSinterNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan Ludings plastic-cohesive force model)
CHertzianViscoelasticNormalSpecies	HertzianViscoelasticNormalSpecies contains the parameters used to describe a Hertzian normal force (The Mindlin model)
CLinearPlasticViscoelasticNormalSpecies	LinearPlasticViscoelasticNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan Ludings plastic-cohesive force model)
CLinearViscoelasticNormalSpecies	LinearViscoelasticNormalSpecies contains the parameters used to describe a linear elastic-dissipative normal force
CSinterNormalSpecies	SinterNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan Ludings plastic-cohesive force model)
CBaseHandler< T >	Container to store the pointers to all objects that one creates in a simulation
►CBaseHandler< BaseBoundary >
CBoundaryHandler	Container to store pointers to all BaseBoundary objects
►CBaseHandler< BaseCG >
CCGHandler	Container that stores all CG objects
►CBaseHandler< BaseInteraction >
CInteractionHandler	Container to store Interaction objects
►CBaseHandler< BaseParticle >
CParticleHandler	Container to store all BaseParticle
►CBaseHandler< BasePeriodicBoundary >
CPeriodicBoundaryHandler	Container to store pointers to all BasePeriodicBoundary objects
►CBaseHandler< BaseWall >
CWallHandler	Container to store all BaseWall
►CBaseHandler< Domain >
CDomainHandler	Container to store all Domain
►CBaseHandler< ParticleSpecies >
CSpeciesHandler	Container to store all ParticleSpecies
►CBaseObject	It is an abstract base class due to the purely virtual functions declared below. Even if the function is purely virtual, it does not imply that it cannot have a definition. Abstract classes are useful to define a interface
►CBaseBoundary
CAngledPeriodicBoundary
►CBasePeriodicBoundary
►CPeriodicBoundary	Defines a pair of periodic walls. Inherits from BaseBoundary
CSubcriticalMaserBoundaryTEST
CCircularPeriodicBoundary	Used to create a circular periodic boundary
CConstantMassFlowMaserBoundary	Variation on the PeriodicBoundary which also has an outflow part
►CDeletionBoundary	Used for removing particles from the problem. Inherits from BaseBoundary. By default, a plane that deletes everything past it, but there are derived classes such as CubeDeletionBoundary
CCubeDeletionBoundary
CDropletBoundary	Supplies a 'constant heat flux' to a cuboidal region (specified by two corner points) by adding a random velocity at each time step to each particle therein, increasing the granular temperature (velocity variance)
CFluxBoundary	Used for measuring flow rates through a given plane; acts like a pair of scales Inherits from BaseBoundary. Can measure forward, backward and net fluxes
CHeaterBoundary	Supplies a 'constant heat flux' to a cuboidal region (specified by two corner points) by adding a random velocity at each time step to each particle therein, increasing the granular temperature (velocity variance)
►CInsertionBoundary	Boundary structure for boundaries used for insertion of particles
►CBaseClusterInsertionBoundary
CFixedClusterInsertionBoundary
CRandomClusterInsertionBoundary
CChuteInsertionBoundary	Used for modeling chute inflow. Inherits from InsertionBoundary
►CCubeInsertionBoundary	It's an insertion boundary which has cuboidal shape (yes, 'CuboidalInsertionBoundary' would have been the correct name)
CBidisperseCubeInsertionBoundary	Like a CubeInsertionBoundary but the particles generated are one of two types
CHopperInsertionBoundary	Inherits from InsertionBoundary Some images are useful to better understand the structure of both the hopper-chute combination, as of the hopper insertion boundary itself:
CPolydisperseInsertionBoundary	Like an InsertionBoundary but generates particles of multiple types. Note that, as a child of InsertionBoundary, this class has a member called particleToCopy_, which is a pointer to a particle. This pointer needs to point to something arbitrary but it doesn't matter what the value is
CLeesEdwardsBoundary	Class which creates a boundary with Lees-Edwards type periodic boundary conditions
CShearBoxBoundary	Class which creates a boundary with Lees-Edwards type periodic boundary conditions
CStressStrainControlBoundary	A cuboid box consists of periodic boundaries that can be strain/stress controlled and achieve different deformation modes. User needs to define target stress/strainrate matrix, gain_factor and a boolean parameter isStrainRateControlled to True/False to activate/deactivate strainrate control
CSubcriticalMaserBoundary	Variation on the PeriodicBoundary which also has an outflow part
►CBaseCG	Base class of all CG objects, needed to store the various CG objects in the CGHandler
►CCG< Coordinates, BaseFunction, Fields >	Evaluates time-resolved continuum fields and writes the data into a stat file
CTimeAveragedCG< Coordinates, BaseFunction, Fields >	Evaluates time-averaged continuum fields and writes the data into a stat file
CTimeSmoothedCG< Coordinates, BaseFunction, Fields >	Evaluates time-smoothed continuum fields and writes the data into a stat file
►CCG< CGCoordinates::XYZ, BaseFunction, Fields >
►CTimeAveragedCG< CGCoordinates::XYZ, BaseFunction, Fields >
►CTimeAveragedCGXYZ< BaseFunction, Fields >	Specialisation of TimeAveragedCG with coordinates XYZ used for LebedevCG
CTimeAveragedLebedevCG< BaseFunction, Fields >
►CBaseInteractable	Defines the basic properties that a interactable object can have
►CBaseParticle
CLiquidFilmParticle
CSphericalParticle	A basic particle
CSuperQuadricParticle
CThermalParticle
►CBaseWall	Basic class for walls
CArcWall	A wall that is the inside of an arc of a cylinder
CBasicIntersectionOfWalls	This is a class defining walls
CBasicUnionOfWalls	This is a class defining walls
CCoil	This class defines a coil in the z-direction from a (constant) starting point, a (constant) length L, a (constant) radius r, a (constant) number or revelations N and a (constant) rotation speed (rev/s)
CCombtooth
CCylindricalWall
CHorizontalScrew	This function defines an Archimedes' screw in the z-direction from a (constant) starting point, a (constant) length L, a (constant) radius r, a (constant) number or revelations N and a (constant) rotation speed (rev/s)
CInfiniteWall	This is a class defining walls
CInfiniteWallWithHole
►CIntersectionOfWalls	A IntersectionOfWalls is convex polygon defined as an intersection of InfiniteWall's
CAxisymmetricIntersectionOfWalls	Use AxisymmetricIntersectionOfWalls to Screw Screw::read Screw::read Screw::read define axisymmetric walls, such as cylinders, cones, etc
CHorizontalBaseScrew	A HorizontalBaseScrew is a copy of AxisymmetricIntersectionOfWalls, with an additional, angle-dependent component
CScrewsymmetricIntersectionOfWalls	Use ScrewsymmetricIntersectionOfWalls to define screwsymmetric walls, such as cylinders, cones, etc
CLevelSetWall	This is a class defining walls
CNurbsWall	This function defines a wall via a NurbsSurface
CParabolaChute
CRestrictedWall	This is a class defining walls
CScrew	This function defines an Archimedes' screw in the z-direction from a (constant) starting point, a (constant) length L, a (constant) radius r, a (constant) number or revelations N and a (constant) rotation speed (rev/s)
CSimpleDrumSuperquadrics	A drum in xz-direction with centre at the origin with a certain radius. Usable with superquadric particles
CSineWall
CSphericalWall	This is a class defining walls
CTriangleWall	A TriangleWall is convex polygon defined as an intersection of InfiniteWall's
CTriangulatedWall	A TriangulatedWall is a triangulation created from a set of vertices and a n-by-3 connectivity matrix defining n faces
CVChute
►CBaseInteraction	Stores information about interactions between two interactable objects; often particles but could be walls etc. By info about interactions one means the overlaps, contact point, forces, torques, relative velocities etc
CBondedInteraction
CChargedBondedInteraction
CEmptyAdhesiveInteraction	In case one doesn't want to have an adhesive (short range non contact) interaction between the interactables (particles or walls), the following class can be used. See Interaction.h, where one can set the Adhesive interaction to EmptyAdhesiveInteraction
CEmptyFrictionInteraction	In case one wants to have a frictionless interaction between the interactables (particles or walls), the following class can be used. See Interaction.h, where one can set the FrictionalForceInteraction to EmptyFrictionInteraction
CHertzianSinterInteraction	Computes normal forces in case of a linear plastic visco-elastic interaction
CHertzianViscoelasticInteraction	Computes normal forces for a Herztian visco-elastic interaction
CLinearPlasticViscoelasticInteraction	Computes normal forces in case of a linear plastic visco-elastic interaction
CLinearViscoelasticInteraction	Enables one to compute normal forces in case of a linear visco-elastic interaction
CLiquidBridgeWilletInteraction	Defines the liquid bridge willet interaction between two particles or walls
CLiquidMigrationWilletInteraction	Defines the liquid bridge willet interaction between two particles or walls
►CMindlinInteraction	Computes the forces corresponding to sliding friction
CMindlinRollingTorsionInteraction	This class allows one to take all three types of frictional interactions into account. The sliding, rolling and torsional frictional interaction. See
CParhamiMcMeekingSinterInteraction
CRegimeSinterInteraction
►CReversibleAdhesiveInteraction
CIrreversibleAdhesiveInteraction
CSinterInteraction	Computes normal forces in case of a linear plastic visco-elastic interaction
►CSlidingFrictionInteraction	Computes the forces corresponding to sliding friction
CFrictionInteraction	This class allows one to take all three types of frictional interactions into account. The sliding, rolling and torsional frictional interaction. See
►CBaseSpecies	BaseSpecies is the class from which all other species are derived
CMixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >	Contains contact force properties for contacts between particles with two different species
►CParticleSpecies
CSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >	Contains material and contact force properties
CDomain	The simulation can be subdivided into Domain's used in parallel code
CBaseVTKWriter< H >
►CBaseVTKWriter< BoundaryHandler >
CBoundaryVTKWriter
►CBaseVTKWriter< InteractionHandler >
CInteractionVTKWriter
►CBaseVTKWriter< ParticleHandler >
►CParticleVtkWriter
CSphericalParticleVtkWriter
CSuperQuadricParticleVtkWriter
►CBaseVTKWriter< WallHandler >
CWallVTKWriter
CBinaryReader	This gives functionality to read information from binary formats like STL etc. This class is complete stand-alone and is tested with one any reference to other MecuryDPM code except Vections and Logger
CBox
CClusterDPM	An object of this class is inside FixedClusterInsertionBoundary and RandomClusterInsertionBoundary
CClusterGenerator	This class allows the user to create clusters of particles. All particles will be of LinearPlasticViscoelasticSpecies and will have a final overlap defined by the user
CClusterInsertionBoundary	It's an insertion boundary which has cuboidal shape and inserts clusters. Two classes (RandomClusterInsertionBoundary and FixedClusterInsertionBoundary) derive from this
CCoordinates	Template argument; use a member class of CGCoordinates to instantiate
CcsvReader	Enables reading of .csv files into MercuryDPM
CDataFiles
►CDPMBase	The DPMBase header includes quite a few header files, defining all the handlers, which are essential. Moreover, it defines and solves a DPM problem. It is inherited from FilesAndRunNumber (public)
►CMercuryBase	This is the base class for both Mercury2D and Mercury3D. Note the actually abstract grid is defined in the class Grid defined below
CMercury2D	This adds on the hierarchical grid code for 2D problems
►CMercury3D	This adds on the hierarchical grid code for 3D problems
CBaseCluster
►CChute	Creates chutes with different bottoms. Inherits from Mercury3D (-> MercuryBase -> DPMBase)
CChuteBottom	Used by Chute::createBottom to create an unordered particle layer
CChuteWithHopper	ChuteWithHopper has a hopper as inflow
CMercury3DRestart	This class adds to Mercury3D the ability to restart after a certain wall time
CStatisticsVector< T >	This class is used to extract statistical data from MD simulations
CDropletBoundary::Droplet
CEmpty	Data class to send an empty class over MPI
CTriangulatedWall::Face	Struct used to store the properties of a face needed for contact detection
CFile
CFileReader	This gives functionality to read information from binary formats like STL etc. This class is complete stand-alone and is tested with one any reference to other MecuryDPM code except Vections and Logger
►CFrictionForceInteraction
CInteraction< NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction >	Contains information about the contact between two interactables, BaseInteraction::P_ and BaseInteraction::I_;
►CFrictionForceSpecies	Defines a contact force orthogonal to the contact normal
CMixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >	Contains contact force properties for contacts between particles with two different species
CSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >	Contains material and contact force properties
CFunction	Template argument; use a member class of CGFunctions to instantiate
CCGFunctions::Gauss< Coordinates >	Defines the position of the CGPoint (e.g. x, y, z) and the parameters of the Gauss coarse-graining function (width and cutoff)
CCGFields::GradVelocityField
CHGrid	In the HGrid class, here all information about the HGrid is stored
CHGridCell	Contains the hGrid-information for a certain particle: x,y,z and level of the particle containing this
CHGridOptimiser
CIFile
CMercuryDataFile::IteratorProxy< NDIMS >
Chelpers::KAndDisp	Return type specifically for fuctions returning k and disp at once
Chelpers::KAndDispAndKtAndDispt	Set disp and k such that is matches a given collision time tc and restitution coefficient r for a collision of effective/reduced mass m
CCGFields::LiquidMigrationFields	Contains the computed field values, like density, momentum and stress
CLL< Level >	Tag for template metaprogramming
CLocalExpansion
►CLoggerGuide
CLogger< L, ASSERTS >	See
CLoggerOutput	Default functions for output generation
CMatrix3D	Implementation of a 3D matrix
CMatrixSymmetric3D	Implementation of a 3D symmetric matrix
CMercuryDataFile
CMercuryParticle< NDIMS >
CMercuryParticle< 2 >
CMercuryTimeStep< NDIMS >
CMercuryTimeStepIterator< NDIMS >
CMPIContainer	This class contains all information and functions required for communication between processors
CMpiID	Data class that specifies the location of a particle in a parallel code
CMPIInteraction< NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction >
CMPIParticleForce	Data class to send a particle force over MPI
CMPIParticlePosition	Data class to send a particle position over MPI
CMPIParticleVelocity	Data class to send a particle velocity over MPI
CMpiPeriodicParticleIDBase
►CMPISphericalParticle
CMPILiquidFilmParticle
CMPIParticle	Data class to send a particle over MPI
CMPISuperQuadric
►CMultipole
CDipole
CIntersectionOfWalls::normalAndPosition
►CNormalForceInteraction
CInteraction< NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction >	Contains information about the contact between two interactables, BaseInteraction::P_ and BaseInteraction::I_;
CThermalInteraction< NormalForceInteraction >
►CNormalForceSpecies	Defines a contact force parallel to the contact normal
CMixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >	Contains contact force properties for contacts between particles with two different species
CSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >	Contains material and contact force properties
CThermalSpecies< NormalForceSpecies >
CNORMALIZED_POLYNOMIAL< T >	This class is used to define polynomial axisymmetric coarse-graining functions
CNumericalVector< T >
CNumericalVector< std::complex< Mdouble > >
CNumericalVector< T >	This is a vector of doubles
CNurbsSurface
CCGFields::OrientationField	Contains the computed field values, like density, momentum and stress
CPanel
►CCGFunctions::Polynomial< Coordinates >	Defines the position of the CGPoint (e.g. x, y, z) and the parameters of a polynomial coarse-graining function (width and cutoff)
CCGFunctions::Heaviside< Coordinates >	A specialisation of Polynomials for PolynomialType::Heaviside. See Polynomial for details
CCGFunctions::Linear< Coordinates >	A specialisation of Polynomials for PolynomialType::Linear. See Polynomial for details
CCGFunctions::Lucy< Coordinates >	A specialisation of Polynomials for PolynomialType::Lucy. See Polynomial for details
CPossibleContact	Class that describes a possible contact between two BaseParticle
CPossibleContactList	Manages the linked list of PossibleContact
►CpqAutoGeneratedObjectPanel
CpqSuperquadricTensorGlyphPanel	Custom panel for SuperquadricTensorGlyph filter
CPSD	Contains a vector with radii and probabilities of a user defined particle size distribution (PSD)
CQuaternion	Implementation of a 3D quaternion (by Vitaliy)
CPSD::RadiusAndProbability	Class which stores radii and probabilities of a PSD. This class should be used as a vector<PSD::RadiusAndProbability>
CReversibleAdheseiveInteraction	Computes the interactions between particles for reversive adhesive contact model
CRNG	This is a class that generates random numbers i.e. named the Random Number Generator (RNG)
CSmallMatrix< numberOfRows, numberOfColumns >	Data type for small dense matrix
CSmallVector< numberOfRows >	Implementation of a 3D vector (by Vitaliy)
CSource
CSphere
CCGFields::StandardFields	Contains the computed field values, like density, momentum and stress
CStatisticsPoint< T >	This class stores statistical values for a given spatial position; to be used in combination with StatisticsVector
CSTLTriangle
CSuperQuad	Class that implements superquadric particles, which are non-spherical
CTime	Allows for timing the algorithms; accurate up to 0.01 sec
CTime2Finish	Estimates the total time, in seconds, left to reach the end of any simulation. First, the class needs to be initialized by calling set. After the class is initialized, an estimate of the total remaining time of the simulation can be found by calling getTime2Finish. The estimate is based on rate at which the simulation time progressed since initialization
CTimeSmoothedFields< Fields >	A helper class for TimeSmoothedCG containing the time-smoothed variables
CVec3D
CVTKCollection
CVTKContainer
CVTKPointDescriptor< T >
►CDetail::VTKPointDescriptorEntry< T >
CDetail::VTKPointDescriptorEntryImpl< T, V >
►CvtkPolyDataAlgorithm
CvtkSuperquadricTensorGlyphFilter
►CvtkTensorGlyph
CvtkTensorGlyphSameEigensystem
CVTKUnstructuredGrid< T >
CBaseFunction< CGCoordinates::XYZ >
►CFields
CCGPoint< Coordinates, Fields >	Combines the position of the CGPoint (e.g. x, y, z), the parameters of the coarse-graining function (e.g. width and cutoff) and the fields to be evaluated (e.g., density, momentum, stress)
Cunsigned
Cunsigned int