Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 12]

►NCGCoordinates	The class in this namespace contain the position of a CGPoint, in the non-averaged directions, and functions that only depend on which non-averaged directions are used
CBase_X_Y_Z	Contains common member functions of the X, Y, and Z classes
CBase_XY_XZ_YZ	Contains common member functions of the XY, XZ, and YZ classes
CBaseCoordinates	Contains common member functions of the X, Y, and Z classes
CO	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
CR	Defines the non-averaged directions on which spatial coarse-graining is applied (the x-direction for R); all other directions are averaged over homogeneously
CRZ	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
CX	Defines the non-averaged directions on which spatial coarse-graining is applied (the x-direction for X); all other directions are averaged over homogeneously
CXY	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
CXYZ	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
CXZ	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
CY	Defines the non-averaged directions on which spatial coarse-graining is applied (the y- direction for Y); all other directions are averaged over homogeneously
CYZ	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
CZ	Defines the non-averaged directions on which spatial coarse-graining is applied (the z-direction for Z); all other directions are averaged over homogeneously
►NCGFields
CGradVelocityField
CLiquidMigrationFields	Contains the computed field values, like density, momentum and stress
COrientationField	Contains the computed field values, like density, momentum and stress
CStandardFields	Contains the computed field values, like density, momentum and stress
►NCGFunctions	Contains base classes of CGPoint; CGPoint is always templated with one of these classes; these classes contain the position of the CGPoint and the parameters of the coarse-graining function (width, cutoff, ...)
CGauss	Defines the position of the CGPoint (e.g. x, y, z) and the parameters of the Gauss coarse-graining function (width and cutoff)
CHeaviside	A specialisation of Polynomials for PolynomialType::Heaviside. See Polynomial for details
CLinear	A specialisation of Polynomials for PolynomialType::Linear. See Polynomial for details
CLucy	A specialisation of Polynomials for PolynomialType::Lucy. See Polynomial for details
CPolynomial	Defines the position of the CGPoint (e.g. x, y, z) and the parameters of a polynomial coarse-graining function (width and cutoff)
►NDetail
CVTKPointDescriptorEntry
CVTKPointDescriptorEntryImpl
►Nhelpers
CKAndDisp	Return type specifically for fuctions returning k and disp at once
CKAndDispAndKtAndDispt	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
►NNurbsUtils
Carray2	A simple class for representing 2D runtime arrays
CAdhesiveForceInteraction
CAdhesiveForceSpecies	Defines a short-range (non-contact) force parallel to the contact normal, usually adhesive
CAngledPeriodicBoundary
CAngledPerioidicBoundary	Defines a pair of periodic walls that are angled around the origin
CArcWall	A wall that is the inside (concave side) of an arc of a cylinder, like a pipe or half-pipe
CAxisymmetricIntersectionOfWalls	Use AxisymmetricIntersectionOfWalls to Screw Screw::read Screw::read Screw::read define axisymmetric walls, such as cylinders, cones, etc
CBaseAdhesiveForce
CBaseBoundary
CBaseCG	Base class of all CG objects, needed to store the various CG objects in the CGHandler
CBaseCluster
CBaseClusterInsertionBoundary
CBaseForce
CBaseFrictionForce
CBaseHandler	Container to store the pointers to all objects that one creates in a simulation
CBaseInteractable	Defines the basic properties that a interactable object can have
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
CBaseNormalForce
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
CBaseParticle
CBasePeriodicBoundary
CBaseSpecies	BaseSpecies is the class from which all other species are derived
CBaseVTKWriter
CBaseWall	Basic class for walls
CBasicIntersectionOfWalls	This is a class defining walls
CBasicUnionOfWalls	This is a class defining walls
CBidisperseCubeInsertionBoundary	Like a CubeInsertionBoundary but the particles generated are one of two types
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
CBondedInteraction
CBondedSpecies	BondedSpecies contains the parameters used to describe a linear irreversible short-range force
CBoundaryHandler	Container to store pointers to all BaseBoundary objects
CBoundaryVTKWriter
CBox
CCG	Evaluates time-resolved continuum fields and writes the data into a stat file
CCGHandler	Container that stores all CG objects
CCGPoint	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)
CChargedBondedInteraction
CChargedBondedSpecies	ChargedBondedSpecies contains the parameters used to describe a linear reversible short-range force
CChute	Creates chutes with different bottoms. Inherits from Mercury3D (-> MercuryBase -> DPMBase)
CChuteBottom	Used by Chute::createBottom to create an unordered particle layer
CChuteInsertionBoundary	Used for modeling chute inflow. Inherits from InsertionBoundary
CChuteWithHopper	ChuteWithHopper has a hopper as inflow
CCircularPeriodicBoundary	Used to create a circular periodic boundary
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
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
CConstantMassFlowMaserBoundary	Variation on the PeriodicBoundary which also has an outflow part
CCoordinates	Template argument; use a member class of CGCoordinates to instantiate
CcsvReader	Enables reading of .csv files into MercuryDPM
CCubeDeletionBoundary
CCubeInsertionBoundary	It's an insertion boundary which has cuboidal shape (yes, 'CuboidalInsertionBoundary' would have been the correct name)
CCylindricalWall
CDataFiles
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
CDipole
CDomain	The simulation can be subdivided into Domain's used in parallel code
CDomainHandler	Container to store all Domain
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)
►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)
CDroplet
CEmpty	Data class to send an empty class over MPI
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
CEmptyAdhesiveSpecies	EmptyAdhesiveSpecies is used to create a force law without a short-range adhesive force
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
CEmptyFrictionSpecies	EmptyFrictionSpecies is used to create a force law without frictional forces
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
CFixedClusterInsertionBoundary
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
CFrictionForceInteraction
CFrictionForceSpecies	Defines a contact force orthogonal to the contact normal
CFrictionInteraction	This class allows one to take all three types of frictional interactions into account. The sliding, rolling and torsional frictional interaction. See
CFrictionSpecies	FrictionSpecies contains the parameters used to describe sliding, rolling and torsional friction
CFunction	Template argument; use a member class of CGFunctions to instantiate
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)
CHertzianSinterInteraction	Computes normal forces in case of a linear plastic visco-elastic interaction
CHertzianSinterNormalSpecies	HertzianSinterNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan Ludings plastic-cohesive force model)
CHertzianViscoelasticInteraction	Computes normal forces for a Herztian visco-elastic interaction
CHertzianViscoelasticNormalSpecies	HertzianViscoelasticNormalSpecies contains the parameters used to describe a Hertzian normal force (The Mindlin model)
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
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:
CHorizontalBaseScrew	A HorizontalBaseScrew is a copy of AxisymmetricIntersectionOfWalls, with an additional, angle-dependent component
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)
CIFile
CInfiniteWall	This is a class defining walls
CInfiniteWallWithHole
CInsertionBoundary	Boundary structure for boundaries used for insertion of particles
CInteraction	Contains information about the contact between two interactables, BaseInteraction::P_ and BaseInteraction::I_;
CInteractionHandler	Container to store Interaction objects
CInteractionVTKWriter
►CIntersectionOfWalls	A IntersectionOfWalls is convex polygon defined as an intersection of InfiniteWall's
CnormalAndPosition
CIrreversibleAdhesiveInteraction
CIrreversibleAdhesiveSpecies	IrreversibleAdhesiveSpecies contains the parameters used to describe a linear irreversible short-range force
CLeesEdwardsBoundary	Class which creates a boundary with Lees-Edwards type periodic boundary conditions
CLevelSetWall	This is a class defining walls
CLinearPlasticViscoelasticInteraction	Computes normal forces in case of a linear plastic visco-elastic interaction
CLinearPlasticViscoelasticNormalSpecies	LinearPlasticViscoelasticNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan Ludings plastic-cohesive force model)
CLinearViscoelasticInteraction	Enables one to compute normal forces in case of a linear visco-elastic interaction
CLinearViscoelasticNormalSpecies	LinearViscoelasticNormalSpecies contains the parameters used to describe a linear elastic-dissipative normal force
CLiquidBridgeWilletInteraction	Defines the liquid bridge willet interaction between two particles or walls
CLiquidBridgeWilletSpecies	LiquidBridgeWilletSpecies contains the parameters used to describe a short-range force caused by liquid bridges
CLiquidFilmParticle
CLiquidMigrationWilletInteraction	Defines the liquid bridge willet interaction between two particles or walls
CLiquidMigrationWilletSpecies	LiquidMigrationWilletSpecies contains the parameters used to describe a short-range force caused by liquid bridges
CLL	Tag for template metaprogramming
CLocalExpansion
CLogger	Logger class is the main class of the logger implementation. It holds all the functions which invoke certain methods to create messages based on input parameter deductions
CLoggerOutput	Default functions for output generation
CMatrix3D	Implementation of a 3D matrix
CMatrixSymmetric3D	Implementation of a 3D symmetric matrix
►CMembrane	A Membrane consists of masses connected by springs
CEdge
CMercury2D	This adds on the hierarchical grid code for 2D problems
CMercury3D	This adds on the hierarchical grid code for 3D problems
CMercury3DRestart	This class adds to Mercury3D the ability to restart after a certain wall time
CMercuryBase	This is the base class for both Mercury2D and Mercury3D. Note the actually abstract grid is defined in the class Grid defined below
►CMercuryDataFile
CIteratorProxy
CMercuryParticle
CMercuryParticle< 2 >
CMercuryTimeStep
CMercuryTimeStepIterator
CMeshTriangle	MeshTriangle implements a triangle whose vertex positions are defined by three particles
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
CMindlinRollingTorsionSpecies	MindlinRollingTorsionSpecies contains the parameters used to describe sliding, rolling and torsional friction
CMindlinSpecies	MindlinSpecies contains the parameters used to describe sliding friction
CMixedSpecies	Contains contact force properties for contacts between particles with two different species
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
CMPILiquidFilmParticle
CMPIParticle	Data class to send a particle over MPI
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
CMPISuperQuadric
CMultipole
CNormalForceInteraction
CNormalForceSpecies	Defines a contact force parallel to the contact normal
CNORMALIZED_POLYNOMIAL	This class is used to define polynomial axisymmetric coarse-graining functions
CNumericalVector
CNumericalVector< T >	This is a vector of doubles
CNurbsSurface
CNurbsWall	This function defines a wall via a NurbsSurface
CPanel
CParabolaChute
CParhamiMcMeekingSinterInteraction
CParhamiMcMeekingSinterSpecies	ParhamiMcMeekingSinterSpecies contains the parameters used to describe a linear reversible short-range force
CParticleHandler	Container to store all BaseParticle
CParticleSpecies
CParticleVtkWriter
CPeriodicBoundary	Defines a pair of periodic walls. Inherits from BaseBoundary
CPeriodicBoundaryHandler	Container to store pointers to all BasePeriodicBoundary objects
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
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)
CRadiusAndProbability	Class which stores radii and probabilities of a PSD. This class should be used as a vector<PSD::RadiusAndProbability>
CQuaternion	Implementation of a 3D quaternion (by Vitaliy)
CRandomClusterInsertionBoundary
CRegimeSinterInteraction
CRegimeSinterSpecies	RegimeSinterSpecies contains the parameters used to describe the sintering of particles following three different mechanisms
CRestrictedWall	This is a class defining walls
CReversibleAdheseiveInteraction	Computes the interactions between particles for reversive adhesive contact model
CReversibleAdhesiveInteraction
CReversibleAdhesiveSpecies	ReversibleAdhesiveSpecies contains the parameters used to describe a linear reversible short-range force
CRNG	This is a class that generates random numbers i.e. named the Random Number Generator (RNG)
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)
CScrewsymmetricIntersectionOfWalls	Use ScrewsymmetricIntersectionOfWalls to define screwsymmetric walls, such as cylinders, cones, etc
CShearBoxBoundary	Class which creates a boundary with Lees-Edwards type periodic boundary conditions
CSimpleDrumSuperquadrics	A drum in xz-direction with centre at the origin with a certain radius. Usable with superquadric particles
CSineWall
CSinterInteraction	Computes normal forces in case of a linear plastic visco-elastic interaction
CSinterNormalSpecies	SinterNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan Ludings plastic-cohesive force model)
CSlidingFrictionInteraction	Computes the forces corresponding to sliding friction
CSlidingFrictionSpecies	SlidingFrictionSpecies contains the parameters used to describe sliding friction
CSmallMatrix	Data type for small dense matrix
CSmallVector	Implementation of a 3D vector (by Vitaliy)
CSource
CSpecies	Contains material and contact force properties
CSpeciesHandler	Container to store all ParticleSpecies
CSphere
CSphericalParticle	A spherical particle is the most simple particle used in MercuryDPM
CSphericalParticleVtkWriter
CSphericalWall	This is a class defining walls
CStatisticsPoint	This class stores statistical values for a given spatial position; to be used in combination with StatisticsVector
CStatisticsVector	This class is used to extract statistical data from MD simulations
CSTLTriangle
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
CSubcriticalMaserBoundaryTEST
CSuperQuad	Class that implements superquadric particles, which are non-spherical
CSuperQuadricParticle
CSuperQuadricParticleVtkWriter
CThermalInteraction
CThermalParticle
CThermalSpecies
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
CTimeAveragedCG	Evaluates time-averaged continuum fields and writes the data into a stat file
CTimeAveragedCGXYZ	Specialisation of TimeAveragedCG with coordinates XYZ used for LebedevCG
CTimeAveragedLebedevCG
CTimeSmoothedCG	Evaluates time-smoothed continuum fields and writes the data into a stat file
CTimeSmoothedFields	A helper class for TimeSmoothedCG containing the time-smoothed variables
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
CFace	Struct used to store the properties of a face needed for contact detection
CVChute
CVec3D
CVTKCollection
CVTKContainer
CVTKPointDescriptor
CvtkPolyDataAlgorithm
CvtkSuperquadricTensorGlyphFilter
CvtkTensorGlyph
CvtkTensorGlyphSameEigensystem
CVTKUnstructuredGrid
CWallHandler	Container to store all BaseWall
CWallVTKWriter