# PhasicFlow: Class List
PhasicFlow is an open-source parallel DEM (discrete element method) package for simulating granular flow. It is developed in C++ and can be exectued on both GPU (like CUDA) and CPU.

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

pFlow |
algorithms |
greater |
less |
maximum |
minimum |
cfModels |
cGAbsoluteLinear |
contactForceStorage |
linearProperties |
cGRelativeLinear |
contactForceStorage |
linearProperties |
grainRolling |
linear |
contactForceStorage |
linearProperties |
nonLinear |
contactForceStorage |
nonLinearProperties |
nonLinearMod |
contactForceStorage |
nonLinearProperties |
normalRolling |
grainInteractionKernels |
ppInteractionFunctor |
pwInteractionFunctor |
grnTriInteraction |
pLine |
triWall |
PFtoVTK |
fileSeries |
sphereInteractionKernels |
ppInteractionFunctor |
pwInteractionFunctor |
sphTriInteraction |
pLine |
triWall |
AB3History |
AB4History |
AB5History |
AdamsBashforth2 | Second order Adams-Bashforth integration method for solving ODE
AdamsBashforth3 | Third order Adams-Bashforth integration method for solving ODE
AdamsBashforth4 | Fourth order Adams-Bashforth integration method for solving ODE
AdamsBashforth5 | Fifth order Adams-Bashforth integration method for solving ODE
AdamsMoulton3 | Third order Adams-Moulton integration method for solving ODE
AdamsMoulton4 | Fourth order Adams-Moulton integration method for solving ODE
AdamsMoulton5 | Fifth order Adams-Moulton integration method for solving ODE
allOp |
anyList |
array2D |
baseShapeNames |
baseTimeControl |
betweenEqOp |
betweenOp |
bitsetHD |
boundariesMask |
boundaryBase |
boundaryContactSearch |
boundaryContactSearchList |
boundaryExit |
boundaryField |
boundaryFieldList |
boundaryGrainInteraction |
boundaryGrainInteractionList |
boundaryGrainParticles |
boundaryGrainParticlesList |
boundaryIntegration |
boundaryIntegrationList |
boundaryList |
boundaryNone |
boundaryPeriodic |
boundaryReflective |
boundarySphereInteraction |
boundarySphereInteractionList |
boundarySphereParticles |
boundarySphereParticlesList |
box |
boxRegion |
cellMapper |
CellIterator |
cells |
cellsWallLevel0 |
TagFindCellRange2 |
checkStatic |
has_static_member_TYPENAME |
has_static_member_TYPENAME< testType, Ret(Args...)> |
Check |
collisionCheck |
combinedRange |
commandLine |
compareOne |
compareTwo |
compareZero |
ContactSearch |
contactSearch |
conveyorBelt | Conveyor belt model for a wall
conveyorBeltMotion | Conveyor belt model for walls
countField |
countFields |
cuboidWall |
cylinder |
cylinderRegion |
cylinderWall |
dataEntry | Data entry to be used in dictionries
dataIO |
dataIORegular |
demComponent | A base class for every main component of DEM system
demGeometry | Base for geometry that manages control
dictionary | Dictionary holds a set of data entries or sub-dictionaries that are enclosed in a curely braces or are in a file
domain |
dynamicLinkLibs |
dynamicPointStructure |
empty |
equalOp |
exitBoundaryField |
Field |
fileDictionary |
fileStream | Creates and manages an input/output file stream with specified format
fileSystem | Manages file pathes, manupulate and combines them
generalBoundary |
geometricRegion |
geometry | Base class for geometry for managing tri-surfaces, geometry motion, and surface physical properties
geometryMotion |
grainInteraction |
grainParticles |
grainShape |
greaterThanEqOp |
greaterThanOp |
hashMap |
iBox |
iEntry | Interface calss for data entry and dictionary
iFstream | Input file stream for reading binary or ascii data from a file
iIstream | Interface class for any input stream
includeMask |
IncludeMask |
IncludeMask< T, allOp< T > > |
indexContainer | It holds two vectors of indecis on Host and Device
IndexAccessor | Helper class for accessing index on host or device
indexMorton |
infinitePlane |
insertion | Base class for particle insertion
Insertion | This class manages all the insertion regions for particles insertion in the simulation
insertionRegion | This class defines all the necessary enteties for defining an insertion region
InsertionRegion | This manages insertion of particles from a region based on the ShapeType
integration | Base class for integrating the first order ODE (IVP)
interaction |
internalField |
internalPoints |
intervalRange |
IOfileHeader |
IOobject |
IOPattern |
iOstream | Interface class for any output stream
IOstream | A base calss for input/output streams
Istream | Standard input stream for binary and ascii data
iTstream | Input token stream
lessThanEqOp |
lessThanOp |
line |
List |
ListPtr |
localProcessors |
Logical | Holds a bool value and converts strings to bool
Map |
mapperNBS |
CellIterator |
MapPtr |
masterOstream | Output stream for MPI parallel run, when we need to know which the processor number in the output line
message |
MotionModel | Motion model abstract class (CRTP) for all the motion models
ModelInterface | Motion model class to be passed to computational units/kernels for transfing points and returning velocities at various positions
MPITimer |
multiRotatingAxis | Defines an axis of rotation that rotates around itself and rotates around another axis
multiRotatingAxisMotion | Rotating axis motion model for walls
Model | Motion model class to be passed to computational units/kernels for transfing points and returning velocities at various positions
multiTriSurface |
NBS |
NBSLevel0 |
noConstructAllocator |
objectFile |
observer |
oFstream | Output file stream to send binary or ascii data to a file
Ostream | Standard output stream for BINARY and ASCII formats
oTstream | Output token stream
particleIdHandler |
particles |
particleWallContactSearchs |
PeakableRegion |
peakableRegion |
periodicBoundaryContactSearch |
periodicBoundaryField |
periodicBoundaryGrainInteraction |
periodicBoundarySphereInteraction |
plane |
planeWall |
pointField |
pointFlag |
pointRectCell |
pointSorting |
pointStructure |
positionOrdered |
positionParticles |
positionRandom |
postprocess |
ppwBndryContactSearch |
processField |
ProcessField |
processorOstream | Output stream for MPI parallel run, when we need to know which the processor number in the output line
processors | This class holds the information about the global execution world and number of processors in communication
property | Property holds the pure properties of materials
pStructSelector |
quadruple |
RandomReal |
randomReal |
Range | Range for elements in an vector [start,end)
readControlDict |
readFromTimeFolder |
rectangleMesh |
rectMeshField |
reflectiveBoundaryField |
regularParticleIdHandler |
regularSimulationDomain |
repository |
rotatingAxis | An axis which rotates around itself at specified speed
rotatingAxisMotion | Rotating axis motion model for walls
scatteredFieldAccess |
selectBox |
selectorGeometric |
selectorRandomPoints |
selectorStridedRange |
setFieldEntry |
setFieldList |
shape |
shapeMixture | Defines a mixture of particles for particle insertion
simulationDomain |
sortedContactList |
TagReFillPairs |
sortedPairs |
pairAccessor |
TagFillFlag |
TagFillPairs |
span |
sphere |
sphereInteraction |
sphereParticles | Class for managing spherical particles
sphereRegion |
sphereShape |
stationary | Stationary model for a wall
stationaryWall | Stationary model for walls
stlFile |
stlWall |
stridedRange |
subDomain |
subscriber |
subSurface |
symArray |
systemControl |
Time |
timeControl |
timeFolder |
timeInfo |
timeInterval |
Timer |
Timers |
token | Token class based on OpenFOAM stream, with some modifications/simplifications to be tailored to our needs
content | A union of token types
triangleAccessor |
triple | A set of 3 variables that can be used for vector variables
triSurface |
triSurfaceField |
twoPartEntry |
uniformRandomReal |
uniformRandomUint32 |
uniquePtr |
unsortedContactList |
TagReFillPairs |
unsortedPairs |
pairAccessor |
Vector |
VectorDual |
VectorSingle |
VectorSingle< word, HostSpace > |
vibrating | Vibrating model for a wall
vibratingMotion | Vibrating motion model for walls
vtkByteSwapper |
vtkByteSwapper< 1 > | With char, no re-ordering is required
vtkByteSwapper< 2 > | Re-order 2-byte data
vtkByteSwapper< 4 > | Re-order 4-byte data
vtkByteSwapper< 8 > | Re-order of 8-byte data
vtkFile |
Wall |
wallBoundaryContactSearch |
zAxis |
RESERVE |