SpatialOps
SpatialOps::Particle::ParticleToCell< CellField > Class Template Reference

Interpolates an extensive particle field onto an underlying mesh field.Note that this should only be used to interpolate extensive quantities and not intensive quantities. More...

#include <ParticleOperators.h>

Public Member Functions

 ParticleToCell (const double dx, const double xlo, const double dy=-1, const double ylo=0, const double dz=-1, const double zlo=0, const InterpOptions method=INTERPOLATE)
 construct a ParticleToCell operator More...
 
void set_coordinate_information (const ParticleField *const pxcoord, const ParticleField *const pycoord, const ParticleField *const pzcoord, const ParticleField *const psize)
 
void apply_to_field (const SrcFieldType &src, DestFieldType &dest) const
 

Detailed Description

template<typename CellField>
class SpatialOps::Particle::ParticleToCell< CellField >

Interpolates an extensive particle field onto an underlying mesh field.

Note that this should only be used to interpolate extensive quantities and not intensive quantities.

Author
James C. Sutherland, Babak Goshayeshi

Definition at line 103 of file ParticleOperators.h.

Constructor & Destructor Documentation

◆ ParticleToCell()

template<typename CellField >
SpatialOps::Particle::ParticleToCell< CellField >::ParticleToCell ( const double  dx,
const double  xlo,
const double  dy = -1,
const double  ylo = 0,
const double  dz = -1,
const double  zlo = 0,
const InterpOptions  method = INTERPOLATE 
)

construct a ParticleToCell operator

Parameters
dxx-direction mesh spacing
xlox-direction low coordinate of CellField (interior - not including ghost cells)
dyy-direction mesh spacing
yloy-direction low coordinate of CellField (interior - not including ghost cells)
dzz-direction mesh spacing
zloz-direction low coordinate of CellField (interior - not including ghost cells)

Definition at line 203 of file ParticleOperators.cpp.

References SpatialOps::Particle::ParticleToCell< CellField >::set_coordinate_information().

Here is the call graph for this function:

Member Function Documentation

◆ apply_to_field()

template<typename CellField >
void SpatialOps::Particle::ParticleToCell< CellField >::apply_to_field ( const SrcFieldType src,
DestFieldType &  dest 
) const
Parameters
srcsource field from which values are interpolated to particles (ParticleField)
destdestination field to which values are interpolated (CellField)

Definition at line 242 of file ParticleOperators.cpp.

References SpatialOps::SpatialField< FieldLocation, T >::begin(), and SpatialOps::SpatialField< FieldLocation, T >::end().

Referenced by SpatialOps::Particle::ParticleToCell< CellField >::set_coordinate_information().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_coordinate_information()

template<typename CellField >
void SpatialOps::Particle::ParticleToCell< CellField >::set_coordinate_information ( const ParticleField *const  pxcoord,
const ParticleField *const  pycoord,
const ParticleField *const  pzcoord,
const ParticleField *const  psize 
)
Parameters
pxcoordx-coordinate of each particle
pycoordy-coordinate of each particle
pzcoordz-coordinate of each particle
psizeparticle diameter - only used if method==INTERPOLATE

Definition at line 226 of file ParticleOperators.cpp.

References SpatialOps::Particle::ParticleToCell< CellField >::apply_to_field().

Referenced by SpatialOps::Particle::ParticleToCell< CellField >::ParticleToCell().

Here is the call graph for this function:
Here is the caller graph for this function:

The documentation for this class was generated from the following files: