SpatialOps
SpatialOps::BasicOpTypes< CellT > Struct Template Reference

Provides typedefs for common operator types on a given volume. More...

#include <FVStaggeredOperatorTypes.h>

Detailed Description

template<typename CellT>
struct SpatialOps::BasicOpTypes< CellT >

Provides typedefs for common operator types on a given volume.

Author
James C. Sutherland
Template Parameters
CellTthe type of volume we are considering.

The following public typedefs are made:

Operator Type Description
InterpC2FX Interpolate to the x-surface
InterpC2FY Interpolate to the y-surface
InterpC2FZ Interpolate to the z-surface
GradX Calculate $\frac{\partial}{\partial x}$ on the x-surface
GradY Calculate $\frac{\partial}{\partial y}$ on the y-surface
GradZ Calculate $\frac{\partial}{\partial z}$ on the z-surface
DivX Calculate the divergence from the x-surface to the volume
DivY Calculate the divergence from the y-surface to the volume
DivZ Calculate the divergence from the z-surface to the volume

This struct is defined for the following field types:

  • SVolField
  • XVolField
  • YVolField
  • ZVolField

Example usage:

typedef BasicOpTypes<SVolField>::GradY MyGradYType;
typedef BasicOpTypes<SVolField>::InterpC2FX InterpSVolSSurfX;
See also
OperatorTypeBuilder
Inferring operator types
Using stencils with fields

Definition at line 114 of file FVStaggeredOperatorTypes.h.


The documentation for this struct was generated from the following file: