SpatialOps
Operator Types

Information about operator types that are predefined in SpatialOps. More...

Classes

struct  SpatialOps::Interpolant
 Defines a type for Interpolant operators. More...
 
struct  SpatialOps::Extrapolant
 Defines a type for Extrapolant operators. More...
 
struct  SpatialOps::Gradient
 Defines a type for Gradient operators. More...
 
struct  SpatialOps::Divergence
 Defines a type for Divergence operators. More...
 
struct  SpatialOps::Filter
 Defines a type for Filter operators. More...
 
struct  SpatialOps::Restriction
 Defines a type for Restriction operators. More...
 
struct  SpatialOps::InterpolantX
 X-interpolant for use with FD operations whose src and dest fields are the same type. More...
 
struct  SpatialOps::InterpolantY
 Y-interpolant for use with FD operations whose src and dest fields are the same type. More...
 
struct  SpatialOps::InterpolantZ
 Z-interpolant for use with FD operations whose src and dest fields are the same type. More...
 
struct  SpatialOps::GradientX
 X-interpolant for use with FD operations whose src and dest fields are the same type. More...
 
struct  SpatialOps::GradientY
 Y-interpolant for use with FD operations whose src and dest fields are the same type. More...
 
struct  SpatialOps::GradientZ
 Z-interpolant for use with FD operations whose src and dest fields are the same type. More...
 
class  SpatialOps::Particle::ParticlesPerCell< CellField >
 Computes the number of particles per cell and accounts for fractional contributions. More...
 
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. More...
 
class  SpatialOps::Particle::CellToParticle< CellField >
 Operator to interpolate a mesh field onto a particle. More...
 
struct  SpatialOps::OperatorTypeBuilder< OpT, SrcT, DestT >
 Builds operator types from field types and operator type descriptors. More...
 
struct  SpatialOps::BasicOpTypes< CellT >
 Provides typedefs for common operator types on a given volume. More...
 
struct  SpatialOps::OneSidedOpTypeBuilder< Op, StencilT, FieldT, Offset >
 Builds OneSidedDiv operator type from field type. More...
 

Functions

void SpatialOps::build_stencils (const unsigned int nx, const unsigned int ny, const unsigned int nz, const double Lx, const double Ly, const double Lz, OperatorDatabase &opdb)
 builds commonly used stencil operators More...
 
void SpatialOps::build_stencils (const Grid &grid, OperatorDatabase &opDB)
 builds commonly used stencil operators More...
 

Detailed Description

Information about operator types that are predefined in SpatialOps.

Function Documentation

◆ build_stencils() [1/2]

void SpatialOps::build_stencils ( const unsigned int  nx,
const unsigned int  ny,
const unsigned int  nz,
const double  Lx,
const double  Ly,
const double  Lz,
OperatorDatabase opdb 
)

builds commonly used stencil operators

Parameters
nxnumber of points in the x-direction
nynumber of points in the y-direction
nznumber of points in the z-direction
Lxlength in x-direction
Lylength in y-direction
Lzlength in z-direction
opdbthe OperatorDatabase to register the operators on

Definition at line 61 of file StencilBuilder.cpp.

References SpatialOps::OperatorDatabase::register_new_operator().

Here is the call graph for this function:

◆ build_stencils() [2/2]

void SpatialOps::build_stencils ( const Grid grid,
OperatorDatabase opDB 
)

builds commonly used stencil operators

Parameters
gridthe grid to build the stencils on
opDBthe OperatorDatabase to store the stencils in

Definition at line 211 of file StencilBuilder.cpp.