MercuryDPM  Beta
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
 NDetail
 Nhelpers
 CAdhesiveForceInteraction
 CAdhesiveForceSpeciesDefines a short-range (non-contact) force parallel to the contact normal, usually adhesive
 CAngledPeriodicBoundary
 CAngledPerioidicBoundaryDefines a pair of periodic walls that are angled around the origin
 CAxisymmetricIntersectionOfWallsA AxisymmetricIntersectionOfWalls is a axisymmetric wall, defined by rotating a twodimensional IntersectionOfWalls around a symmetry axis
 CBaseBoundary
 CBaseHandlerContainer to store the pointers to all objects that one creates in a simulation
 CBaseInteractableDefines the basic properties that a interactable object can have
 CBaseInteractionStores 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
 CBaseObjectIt 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
 CBaseSpeciesBaseSpecies is the class from which all other species are derived
 CBaseWallBasic class for walls
 CBoundaryHandlerContainer to store pointers to all BaseBoundary objects
 CChuteCreates chutes with different bottoms. Inherits from Mercury3D (-> MercuryBase -> DPMBase)
 CChuteBottomUsed by Chute::createBottom to create an unordered particle layer
 CChuteInsertionBoundaryUsed for modeling chute inflow. Inherits from InsertionBoundary
 CChuteWithHopperChuteWithHopper has a hopper as inflow
 CCircularPeriodicBoundaryUsed to create a circular periodic boundary
 CCoilThis 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)
 CCubeInsertionBoundaryIt's an insertion boundary which has cuboidal shape (yes, 'CuboidalInsertionBoundary' would have been the correct name)
 CCylindricalWall
 CDeletionBoundaryUsed for removing particles from the problem. Inherits from BaseBoundary
 CDPMBaseThe 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)
 CEmptyAdhesiveInteractionIn 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
 CEmptyAdhesiveSpeciesEmptyAdhesiveSpecies is used to create a force law without a short-range adhesive force
 CEmptyFrictionInteractionIn 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
 CEmptyFrictionSpeciesEmptyFrictionSpecies is used to create a force law without frictional forces
 CFile
 CFilesEvery simulation requires data files to store all the information necessary for visualisation and analysis. The class File provides an fstream variable for reading/writing i.e. input and output
 CFilesAndRunNumberIt is publicly inherited from class Files. It defines an awesome feature that is ideal when doing a parameter study. Below are the routines that manipulate a counter file, called COUNTER_DONOTDEL, to store run numbers
 CFrictionForceInteraction
 CFrictionForceSpeciesDefines a contact force orthogonal to the contact normal
 CFrictionInteractionThis class allows one to take all three types of frictional interactions into account. The sliding, rolling and torsional frictional interaction. See
 CFrictionSpeciesFrictionSpecies contains the parameters used to describe sliding, rolling and torsional friction
 CHertzianViscoelasticInteractionComputes normal forces for a Herztian visco-elastic interaction
 CHertzianViscoelasticNormalSpeciesHertzianViscoelasticNormalSpecies contains the parameters used to describe a Hertzian normal force (The Mindlin model)
 CHGridIn the HGrid class, here all information about the HGrid is stored
 CHGridOptimiser
 CHopperInsertionBoundaryInherits from InsertionBoundary Some images are useful to better understand the structure of both the hopper-chute combination, as of the hopper insertion boundary itself:
 CInfiniteWallThis is a class defining walls
 CInfiniteWallWithHole
 CInsertionBoundaryBoundary structure for boundaries used for insertion of particles
 CInteractionContains information about the contact between two interactables, BaseInteraction::P_ and BaseInteraction::I_;
 CInteractionHandlerContainer to store Interaction objects
 CIntersectionOfWallsA IntersectionOfWalls is convex polygon defined as an intersection of InfiniteWall's
 CIrreversibleAdhesiveInteraction
 CIrreversibleAdhesiveSpeciesIrreversibleAdhesiveSpecies contains the parameters used to describe a linear irreversible short-range force
 CLeesEdwardsBoundaryClass which creates a boundary with Lees-Edwards type periodic boundary conditions
 CLinearPlasticViscoelasticInteractionComputes normal forces in case of a linear plastic visco-elastic interaction
 CLinearPlasticViscoelasticNormalSpeciesLinearPlasticViscoelasticNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan Ludings plastic-cohesive force model)
 CLinearViscoelasticInteractionEnables one to compute normal forces in case of a linear visco-elastic interaction
 CLinearViscoelasticNormalSpeciesLinearViscoelasticNormalSpecies contains the parameters used to describe a linear elastic-dissipative normal force
 CLiquidBridgeWilletInteractionDefines the liquid bridge willet interaction between two particles or walls
 CLiquidBridgeWilletSpeciesLiquidBridgeWilletSpecies contains the parameters used to describe a short-range force caused by liquid bridges
 CLLTag for template metaprogramming
 CLoggerLogger
 CLoggerOutputDefault functions for output generation
 CMaserBoundaryVariation on the PeriodicBoundary with maser-like properties
 CMatrix3DImplementation of a 3D matrix
 CMatrixSymmetric3DImplementation of a 3D symmetric matrix
 CMercury2DThis adds on the hierarchical grid code for 2D problems
 CMercury3DThis adds on the hierarchical grid code for 3D problems
 CMercury3DRestartThis class adds to Mercury3D the ability to restart after a certain wall time
 CMercuryBaseThis is the base class for both Mercury2D and Mercury3D. Note the actually abstract grid is defined in the class Grid defined below
 CMercuryDataFile
 CMercuryParticle
 CMercuryParticle< 2 >
 CMercuryTimeStep
 CMercuryTimeStepIterator
 CMixedSpeciesContains contact force properties for contacts between particles with two different species
 CNormalForceInteraction
 CNormalForceSpeciesDefines a contact force parallel to the contact normal
 CNORMALIZED_POLYNOMIALThis class is used to define polynomial axisymmetric coarse-graining functions
 CParticleHandlerContainer to store all BaseParticle
 CParticleSpecies
 CPeriodicBoundaryDefines a pair of periodic walls. Inherits from BaseBoundary
 CPossibleContactClass that describes a possible contact between two BaseParticle
 CPossibleContactListManages the linked list of PossibleContact
 CQuarternion
 CQuaternion
 CReversibleAdheseiveInteractionComputes the interactions between particles for reversive adhesive contact model
 CReversibleAdhesiveInteraction
 CReversibleAdhesiveSpeciesReversibleAdhesiveSpecies contains the parameters used to describe a linear reversible short-range force
 CRNGThis is a class that generates random numbers i.e. named the Random Number Generator (RNG)
 CScrewThis 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)
 CSlidingFrictionInteractionComputes the forces corresponding to sliding friction
 CSlidingFrictionSpeciesSlidingFrictionSpecies contains the parameters used to describe sliding friction
 CSpeciesContains material and contact force properties
 CSpeciesHandlerContainer to store all ParticleSpecies
 CStatisticsPointThis class stores statistical values for a given spatial position; to be used in combination with StatisticsVector
 CStatisticsVectorThis class is used to extract statistical data from MD simulations
 CTimeAllows for timing the algorithms; accurate up to 0.01 sec
 CTime2FinishEstimates 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
 CVec3DImplementation of a 3D vector (by Vitaliy)
 CVTKCollection
 CVTKPointDescriptor
 CVTKUnstructuredGrid
 CWallHandlerContainer to store all BaseWall