24#ifndef HEMOCELLFIELDS_H
25#define HEMOCELLFIELDS_H
28class bindingFieldHelper;
29class InteriorViscosityHelper;
39#include "latticeBoltzmann/advectionDiffusionLattices.hh"
40#include "multiBlock/multiBlockLattice3D.hh"
41#include "offLattice/triangularSurfaceMesh.hh"
42#include "libraryInterfaces/TINYXML_xmlIO.hh"
43#include "particles/multiParticleField3D.hh"
44#include "parallelism/parallelBlockCommunicator3D.h"
57 HemoCellFields(plb::MultiBlockLattice3D<T, DESCRIPTOR> & lattice_,
unsigned int particleEnvelopeWidth,
HemoCell &);
63 void createParticleField(plb::SparseBlockStructure3D * sbStructure_ = 0, plb::ThreadAttribution * tAttribution_ = 0);
96 void load(plb::XMLreader * documentXML,
unsigned int & iter,
Config * cfg = NULL);
102 void save(plb::XMLreader * documentXML,
unsigned int iter,
Config * cfg = NULL);
199 void getParticles(std::vector<HemoCellParticle *> & particles, plb::Box3D & domain);
202 void addParticles(std::vector<HemoCellParticle> & particles);
223 plb::MultiBlockLattice3D<T, DESCRIPTOR> *
lattice;
240 plb::MultiBlockLattice3D<T, CEPAC_DESCRIPTOR> *
CEPACfield = 0;
Definition hemoCellField.h:42
Complete cells for reading, without changing the simulation.
Definition hemoCellFields.h:181
CompleteCellsScope(const CompleteCellsScope &)=delete
HemoCellFields & fields
Definition hemoCellFields.h:189
CompleteCellsScope & operator=(const CompleteCellsScope &)=delete
~CompleteCellsScope()
Definition hemoCellFields.cpp:924
Definition hemoCellFields.h:351
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:745
HemoAdvanceParticles * clone() const
Definition hemoCellFields.cpp:1009
Definition hemoCellFields.h:355
bool forced
Definition hemoCellFields.h:360
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:771
HemoApplyConstitutiveModel * clone() const
Definition hemoCellFields.cpp:1012
Definition hemoCellFields.h:366
bool resetFirst
Definition hemoCellFields.h:371
HemoBoundaryRepulsionForce * clone() const
Definition hemoCellFields.cpp:1018
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:822
Definition hemoCellFields.h:373
bool verbose
Definition hemoCellFields.h:378
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:892
HemoDeleteIncompleteCells * clone() const
Definition hemoCellFields.cpp:1021
Definition hemoCellFields.h:404
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:955
HemoDeleteNonLocalParticles * clone() const
Definition hemoCellFields.cpp:1033
int envelopeSize
Definition hemoCellFields.h:409
HemoDeleteNonLocalParticles(int envelope_)
Definition hemoCellFields.h:410
Definition hemoCellFields.h:336
HemoFindInternalParticleGridPoints * clone() const
Definition hemoCellFields.cpp:994
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:440
Definition hemoCellFields.h:380
std::vector< HemoCellParticle * > & particles
Definition hemoCellFields.h:381
HemoGetParticles * clone() const
Definition hemoCellFields.cpp:1024
HemoGetParticles(std::vector< HemoCellParticle * > &particles_)
Definition hemoCellFields.h:386
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:931
Definition hemoCellFields.h:341
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:452
HemoInternalGridPointsMembrane * clone() const
Definition hemoCellFields.cpp:991
Definition hemoCellFields.h:347
HemoInterpolateFluidVelocity * clone() const
Definition hemoCellFields.cpp:1006
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:464
Definition hemoCellFields.h:400
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:849
HemoPopulateBindingSites * clone() const
Definition hemoCellFields.cpp:1042
Definition hemoCellFields.h:396
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:838
HemoPopulateBoundaryParticles * clone() const
Definition hemoCellFields.cpp:1030
Definition hemoCellFields.h:416
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:980
HemoPrepareSolidification * clone() const
Definition hemoCellFields.cpp:1039
Definition hemoCellFields.h:362
HemoRepulsionForce * clone() const
Definition hemoCellFields.cpp:1015
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:800
Definition hemoCellFields.h:324
HemoSeperateForceVectors * clone() const
Definition hemoCellFields.cpp:997
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:880
Definition hemoCellFields.h:388
HemoSetParticles * clone() const
Definition hemoCellFields.cpp:1027
HemoSetParticles(std::vector< HemoCellParticle > &particles_)
Definition hemoCellFields.h:394
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:942
std::vector< HemoCellParticle > & particles
Definition hemoCellFields.h:389
Definition hemoCellFields.h:412
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:970
HemoSolidifyCells * clone() const
Definition hemoCellFields.cpp:1036
Definition hemoCellFields.h:332
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:758
HemoSpreadParticleForce * clone() const
Definition hemoCellFields.cpp:1003
Definition hemoCellFields.h:328
HemoUnifyForceVectors * clone() const
Definition hemoCellFields.cpp:1000
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:787
Definition hemoCellFields.h:420
void processGenericBlocks(plb::Box3D, std::vector< plb::AtomicBlock3D * >)
Definition hemoCellFields.cpp:867
unsigned int rtime
Definition hemoCellFields.h:425
HemoupdateResidenceTime * clone() const
Definition hemoCellFields.cpp:1045
Definition hemoCellFields.h:54
std::vector< std::vector< int > > envelopeSendSizes
Definition hemoCellFields.h:284
void prepareSolidification()
Definition hemoCellFields.cpp:985
pluint solidifyTimescale
Definition hemoCellFields.h:263
pluint boundaryRepulsionTimescale
Timescale seperation for boundary repulsion, set through hemocell.h.
Definition hemoCellFields.h:258
void unify_force_vectors()
Unify the force vectors of particles to point to a single force.
Definition hemoCellFields.cpp:790
unsigned int size()
Get the number of celltypes.
Definition hemoCellFields.cpp:146
T repulsionCutoff
Repulsion cutoff [lattice units], set by HemoCell::setRepulsion()
Definition hemoCellFields.h:247
bool number_of_cells_from_checkpoint
Definition hemoCellFields.h:303
plb::MultiParticleField3D< HemoCellParticleField > * immersedParticles
palabos field storing the particles
Definition hemoCellFields.h:235
unsigned int completeCellsScopes
Number of CompleteCellsScope objects that exist (they nest).
Definition hemoCellFields.h:293
T boundaryRepulsionConstant
Wall repulsion constant [lattice force units], set by HemoCell::enableBoundaryParticles() (in pN)
Definition hemoCellFields.h:256
void checkCheckPointFingerprint(plb::XMLreader &documentXML)
Definition hemoCellFields.cpp:385
MPI_Comm particleComm
Definition hemoCellFields.h:291
std::vector< std::vector< int > > envelopeRecvSizes
Definition hemoCellFields.h:284
std::vector< HemoCellField * > cellFields
Vector containing the cellTypes.
Definition hemoCellFields.h:231
int periodicity_limit[3]
Limit of cycles in a direction (xyz); offsets below must match these defaults.
Definition hemoCellFields.h:269
void internalGridPointsMembrane()
Definition hemoCellFields.cpp:457
std::vector< std::vector< NoInitChar > > recvBuffers
Definition hemoCellFields.h:280
HemoCell & hemocell
Reference to parent.
Definition hemoCellFields.h:229
HemoCellField * addCellType(std::string name_, int constructType)
Add a cell type with a certain mesh; its name also selects name_.xml and name_.pos
Definition hemoCellFields.cpp:140
void solidifyCells()
Conditionally solidify cells if requested.
Definition hemoCellFields.cpp:974
std::vector< std::vector< NoInitChar > > envelopeRecvData
Definition hemoCellFields.h:285
void createCEPACfield()
Definition hemoCellFields.cpp:118
void populateBindingSites(plb::Box3D *box=0)
Add bindingSites.
Definition hemoCellFields.cpp:852
void capRepulsionForce()
Definition hemoCellFields.cpp:814
void addParticles(std::vector< HemoCellParticle > &particles)
Add particles to local processors.
Definition hemoCellFields.cpp:948
void applyBoundaryRepulsionForce(bool resetFirst=false)
Definition hemoCellFields.cpp:826
std::vector< std::vector< const plb::CommunicationInfo3D * > > envelopeRecvInfos
Definition hemoCellFields.h:286
bool placeCellsAcrossPeriodicBoundaries
Definition hemoCellFields.h:244
void spreadParticleForce()
Spread the force of all particles over the fluid in this iteration.
Definition hemoCellFields.cpp:761
std::vector< int > envelopeSendRanks
Definition hemoCellFields.h:283
void deleteBrokenCells(plint envelope, bool verbose)
Definition hemoCellFields.cpp:907
void createParticleField(plb::SparseBlockStructure3D *sbStructure_=0, plb::ThreadAttribution *tAttribution_=0)
Definition hemoCellFields.cpp:72
void applyRepulsionForce()
Apply (and calculate) the repulsion force between particles.
Definition hemoCellFields.cpp:803
~HemoCellFields()
Generic Destructor.
Definition hemoCellFields.cpp:59
std::vector< std::vector< NoInitChar > > sendBuffers
Definition hemoCellFields.h:280
bindingFieldHelper * bindingHelper
Definition hemoCellFields.h:314
void applyConstitutiveModel(bool forced=false)
Apply the material model of the cells to the particles, updating their force.
Definition hemoCellFields.cpp:775
std::vector< std::vector< NoInitChar > > envelopeSendData
Definition hemoCellFields.h:285
plb::MultiParticleField3D< HemoCellParticleField > * domain_immersedParticles
Definition hemoCellFields.h:237
void updateResidenceTime(unsigned int rtime)
increment cell residence time
Definition hemoCellFields.cpp:870
pluint envelopeSize
The envelopeSize for the particles.
Definition hemoCellFields.h:233
void save(plb::XMLreader *documentXML, unsigned int iter, Config *cfg=NULL)
Definition hemoCellFields.cpp:283
int periodicity_limit_offset_z
Definition hemoCellFields.h:272
plb::MultiBlockLattice3D< T, DESCRIPTOR > * lattice
the fluid lattice
Definition hemoCellFields.h:223
void saveCheckPointDescription(plb::XMLreader *documentXML, unsigned int iter)
Definition hemoCellFields.cpp:355
pluint interiorViscosityEntireGridTimescale
Definition hemoCellFields.h:266
void advanceParticles()
Advance the particles in an iteration.
Definition hemoCellFields.cpp:748
plb::CommunicationStructure3D * large_communicator
Definition hemoCellFields.h:317
void deleteNonLocalParticles(int envelope)
Delete non local particles (do not delete in envelopesize)
Definition hemoCellFields.cpp:960
std::vector< int > envelopeRecvRanks
Definition hemoCellFields.h:283
plint base_cell_id(plint wrapped) const
Definition hemoCellFields.h:307
void copyXMLreader2XMLwriter(plb::XMLreader const &reader, plb::XMLwriter &writer)
Definition hemoCellFields.cpp:167
T boundaryRepulsionCutoff
Wall repulsion cutoff [lattice units], set by HemoCell::enableBoundaryParticles()
Definition hemoCellFields.h:254
void populateBoundaryParticles()
Add boundary particles on the fluid-solid boundary.
Definition hemoCellFields.cpp:842
std::vector< int > desiredFluidOutputVariables
A vector specifying the output variables (from const_defaults.h)
Definition hemoCellFields.h:225
pluint repulsionTimescale
Timescale seperation for repulsion, set through hemocell.h.
Definition hemoCellFields.h:251
void readPositionsCellFields(std::string particlePosFile)
Legacy reads in only RBC an PLT from a single pos file.
plb::MultiParticleField3D< HemoCellParticleField > & getParticleField3D()
Legacy Helper function to get the particle field, mostly unused as direct access is available.
Definition hemoCellFields.cpp:1050
unsigned int max_neighbours
Definition hemoCellFields.h:310
void separate_force_vectors()
Separate the force vectors of particles so it becomes clear what the vector for each separate force i...
Definition hemoCellFields.cpp:883
void load(plb::XMLreader *documentXML, unsigned int &iter, Config *cfg=NULL)
Definition hemoCellFields.cpp:226
plb::MultiParticleField3D< HemoCellParticleField > * preinlet_immersedParticles
seperate preinlet and domain pointers whenever necessary
Definition hemoCellFields.h:237
void calculateCommunicationStructure()
Definition hemoCellFields.cpp:478
void syncEnvelopes()
Sync the particle envelopes between domains.
Definition hemoCellFields.cpp:618
void getParticles(std::vector< HemoCellParticle * > &particles, plb::Box3D &domain)
Get particles in a given domain.
Definition hemoCellFields.cpp:937
void loadCEPACfield(const std::string &checkpointDirectory)
Load the CEPAC field from a checkpoint directory if it is enabled and present.
Definition hemoCellFields.cpp:425
void interpolateFluidVelocity()
Interpolate the velocity of the fluid to the individual particles.
Definition hemoCellFields.cpp:468
void exchangeEnvelopes()
Definition hemoCellFields.cpp:497
pluint particleVelocityUpdateTimescale
Timescale seperation for the velocity interpolation from the fluid to the particle.
Definition hemoCellFields.h:261
pluint interiorViscosityTimescale
Definition hemoCellFields.h:265
void deleteIncompleteCells(bool verbose=true)
Delete any incomplete cells on a block.
Definition hemoCellFields.cpp:896
int periodicity_limit_offset_y
Definition hemoCellFields.h:271
T repulsionConstant
Repulsion constant [lattice force units], set by HemoCell::setRepulsion() (in pN)
Definition hemoCellFields.h:249
std::vector< int > desiredCEPACfieldOutputVariables
Definition hemoCellFields.h:227
void findInternalParticleGridPoints()
Definition hemoCellFields.cpp:445
int number_of_cells
Definition hemoCellFields.h:300
HemoCellField * operator[](unsigned int index)
Easy access to contained celltypes.
Definition hemoCellFields.cpp:150
plb::MultiBlockLattice3D< T, CEPAC_DESCRIPTOR > * CEPACfield
palabos field for storing the CPAC scalar field if used
Definition hemoCellFields.h:240
InteriorViscosityHelper * interiorViscosityHelper
Definition hemoCellFields.h:315
void InitAfterLoadCheckpoint()
Used to set variables inside the celltypes for correct access, called through createParticleField.
Definition hemoCellFields.cpp:189
Definition hemoCellFunctional.h:37
Definition interiorViscosity.h:31
Definition bindingField.h:31
double T
Definition constant_defaults.h:137
long int plint
Definition constant_defaults.h:149
long unsigned int pluint
Definition constant_defaults.h:152