MercuryDPM  Trunk
 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]
 NCGCoordinatesThe 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
 NCGFields
 NCGFunctionsContains 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, ...)
 NDetail
 Nhelpers
 NNurbsUtils
 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
 CArcWallA wall that is the inside of an arc of a cylinder
 CAxisymmetricIntersectionOfWallsUse AxisymmetricIntersectionOfWalls to define axisymmetric walls, such as cylinders, cones, etc
 CBaseBoundary
 CBaseCGBase class of all CG objects, needed to store the various CG objects in the CGHandler
 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
 CBasePeriodicBoundary
 CBaseSpeciesBaseSpecies is the class from which all other species are derived
 CBaseVTKWriter
 CBaseWallBasic class for walls
 CBasicIntersectionOfWallsThis is a class defining walls
 CBasicUnionOfWallsThis is a class defining walls
 CBidisperseCubeInsertionBoundaryLike a CubeInsertionBoundary but the particles generated are one of two types
 CBinaryReaderThis 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
 CBondedSpeciesBondedSpecies contains the parameters used to describe a linear irreversible short-range force
 CBoundaryHandlerContainer to store pointers to all BaseBoundary objects
 CBox
 CCGEvaluates time-resolved continuum fields and writes the data into a stat file
 CCGHandlerContainer that stores all CG objects
 CCGPointCombines 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
 CChargedBondedSpeciesChargedBondedSpecies contains the parameters used to describe a linear reversible short-range force
 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)
 CCombtooth
 CConstantMassFlowMaserBoundaryVariation on the PeriodicBoundary which also has an outflow part
 CCoordinatesTemplate argument; use a member class of CGCoordinates to instantiate
 CCubeDeletionBoundary
 CCubeInsertionBoundaryIt's an insertion boundary which has cuboidal shape (yes, 'CuboidalInsertionBoundary' would have been the correct name)
 CCylindricalWall
 CDataFiles
 CDeletionBoundaryUsed 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
 CDomainThe simulation can be subdivided into Domain's used in parallel code
 CDomainHandlerContainer to store all Domain
 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)
 CEmptyData class to send an empty class over MPI
 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
 CFileReaderThis 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
 CFluxBoundaryUsed 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
 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
 CFunctionTemplate argument; use a member class of CGFunctions to instantiate
 CHeaterBoundarySupplies 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)
 CHertzianSinterInteractionComputes normal forces in case of a linear plastic visco-elastic interaction
 CHertzianSinterNormalSpeciesHertzianSinterNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan Ludings plastic-cohesive force model)
 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
 CHGridCellContains the hGrid-information for a certain particle: x,y,z and level of the particle containing this
 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:
 CHorizontalBaseScrewA HorizontalBaseScrew is a copy of AxisymmetricIntersectionOfWalls, with an additional, angle-dependent component
 CHorizontalScrewThis 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
 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
 CInteractionVTKWriter
 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
 CLevelSetWallThis is a class defining walls
 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
 CLiquidFilmParticle
 CLiquidMigrationWilletInteractionDefines the liquid bridge willet interaction between two particles or walls
 CLiquidMigrationWilletSpeciesLiquidMigrationWilletSpecies contains the parameters used to describe a short-range force caused by liquid bridges
 CLLTag for template metaprogramming
 CLocalExpansion
 CLoggerSee How to use the logger for details on how to use the logger
 CLoggerOutputDefault functions for output generation
 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
 CMindlinInteractionComputes the forces corresponding to sliding friction
 CMindlinRollingTorsionInteractionThis class allows one to take all three types of frictional interactions into account. The sliding, rolling and torsional frictional interaction. See
 CMindlinRollingTorsionSpeciesMindlinRollingTorsionSpecies contains the parameters used to describe sliding, rolling and torsional friction
 CMindlinSpeciesMindlinSpecies contains the parameters used to describe sliding friction
 CMixedSpeciesContains contact force properties for contacts between particles with two different species
 CMPIContainerThis class contains all information and functions required for communication between processors
 CMpiIDData class that specifies the location of a particle in a parallel code
 CMPIInteraction
 CMPIParticleData class to send a particle over MPI
 CMPIParticleForceData class to send a particle force over MPI
 CMPIParticlePositionData class to send a particle position over MPI
 CMPIParticleVelocityData class to send a particle velocity over MPI
 CMpiPeriodicParticleIDBase
 CMPISuperQuadric
 CMultipole
 CNormalForceInteraction
 CNormalForceSpeciesDefines a contact force parallel to the contact normal
 CNORMALIZED_POLYNOMIALThis class is used to define polynomial axisymmetric coarse-graining functions
 CNumericalVector
 CNumericalVector< T >This is a vector of doubles
 CNurbsSurface
 CNurbsWallThis function defines a wall via a NurbsSurface
 CPanel
 CParabolaChute
 CParhamiMcMeekingSinterInteraction
 CParhamiMcMeekingSinterSpeciesParhamiMcMeekingSinterSpecies contains the parameters used to describe a linear reversible short-range force
 CParticleHandlerContainer to store all BaseParticle
 CParticleSpecies
 CParticleVtkWriter
 CPeriodicBoundaryDefines a pair of periodic walls. Inherits from BaseBoundary
 CPeriodicBoundaryHandlerContainer to store pointers to all BasePeriodicBoundary objects
 CPolydisperseInsertionBoundaryLike 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
 CPossibleContactClass that describes a possible contact between two BaseParticle
 CPossibleContactListManages the linked list of PossibleContact
 CpqAutoGeneratedObjectPanel
 CpqSuperquadricTensorGlyphPanelCustom panel for SuperquadricTensorGlyph filter
 CPSDStores a radius and a cumulative number density: To be used as a vector, std::vector<PSD> psd For each particle, there is the probability p_i that its radius r is less than r_i
 CQuaternionImplementation of a 3D quaternion (by Vitaliy)
 CRestrictedWallThis is a class defining walls
 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)
 CShearBoxBoundaryClass which creates a boundary with Lees-Edwards type periodic boundary conditions
 CSimpleDrumSuperquadricsA drum in xz-direction with centre at the origin with a certain radius. Usable with superquadric particles
 CSineWall
 CSinterInteractionComputes normal forces in case of a linear plastic visco-elastic interaction
 CSinterNormalSpeciesSinterNormalSpecies contains the parameters used to describe a plastic-cohesive normal force (Stefan Ludings plastic-cohesive force model)
 CSlidingFrictionInteractionComputes the forces corresponding to sliding friction
 CSlidingFrictionSpeciesSlidingFrictionSpecies contains the parameters used to describe sliding friction
 CSmallMatrixData type for small dense matrix
 CSmallVectorImplementation of a 3D vector (by Vitaliy)
 CSource
 CSpeciesContains material and contact force properties
 CSpeciesHandlerContainer to store all ParticleSpecies
 CSphere
 CSphericalParticleA basic particle
 CSphericalParticleVtkWriter
 CSphericalWallThis is a class defining walls
 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
 CSTLTriangle
 CStressStrainControlBoundaryPerodic boundary that can be strain/stress controlled and achieve different deformation modes
 CSubcriticalMaserBoundaryVariation on the PeriodicBoundary which also has an outflow part
 CSubcriticalMaserBoundaryTEST
 CSuperQuadClass that implements superquadric particles, which are non-spherical
 CSuperQuadricParticle
 CSuperQuadricParticleVtkWriter
 CThermalInteraction
 CThermalParticle
 CThermalSpecies
 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
 CTimeAveragedCGEvaluates time-averaged continuum fields and writes the data into a stat file
 CTimeAveragedCGXYZSpecialisation of TimeAveragedCG with coordinates XYZ used for LebedevCG
 CTimeAveragedLebedevCG
 CTimeSmoothedCGEvaluates time-smoothed continuum fields and writes the data into a stat file
 CTimeSmoothedFieldsA helper class for TimeSmoothedCG containing the time-smoothed variables
 CTriangleWallA TriangleWall is convex polygon defined as an intersection of InfiniteWall's
 CTriangulatedWallA TriangulatedWall is a triangulation created from a set of vertices and a n-by-3 connectivity matrix defining n faces
 CVChute
 CVec3D
 CVTKCollection
 CVTKContainer
 CVTKPointDescriptor
 CvtkPolyDataAlgorithm
 CvtkSuperquadricTensorGlyphFilter
 CvtkTensorGlyph
 CvtkTensorGlyphSameEigensystem
 CVTKUnstructuredGrid
 CWallHandlerContainer to store all BaseWall
 CWallVTKWriter