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

Operator to interpolate a mesh field onto a particle. More...

#include <ParticleOperators.h>

Public Member Functions

 CellToParticle (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 CellToParticle operator. More...
 
void set_coordinate_information (const ParticleField *pxcoord, const ParticleField *pycoord, const ParticleField *pzcoord, const ParticleField *psize)
 
void apply_to_field (const SrcFieldType &src, DestFieldType &dest) const
 

Detailed Description

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

Operator to interpolate a mesh field onto a particle.

Author
James C. Sutherland, Babak Goshayeshi Operator to interpolate a mesh field onto a particle.

Note that this can be used for either intensive or extensive quantities.

Definition at line 165 of file ParticleOperators.h.

Constructor & Destructor Documentation

◆ CellToParticle()

template<typename CellField >
SpatialOps::Particle::CellToParticle< CellField >::CellToParticle ( 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 CellToParticle 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 386 of file ParticleOperatorsImplementation.h.

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

Here is the call graph for this function:

Member Function Documentation

◆ apply_to_field()

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

Definition at line 425 of file ParticleOperatorsImplementation.h.

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

Referenced by SpatialOps::Particle::CellToParticle< 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::CellToParticle< CellField >::set_coordinate_information ( const ParticleField pxcoord,
const ParticleField pycoord,
const ParticleField pzcoord,
const ParticleField psize 
)
Parameters
pxcoordx-coordinate of each particle
pycoordy-coordinate of each particle
pzcoordz-coordinate of each particle
psizediameter of each particle - It is not going be used! However, it is kept in the declration to be consistent.

Definition at line 409 of file ParticleOperatorsImplementation.h.

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

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

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: