SpatialOps
SpatialOps::OneSidedOpTypeBuilder< Op, StencilT, FieldT, Offset > Struct Template Reference

Builds OneSidedDiv operator type from field type. More...

#include <OneSidedOperatorTypes.h>

Detailed Description

template<typename Op, typename StencilT, typename FieldT, typename Offset = IndexTriplet<0,0,0>>
struct SpatialOps::OneSidedOpTypeBuilder< Op, StencilT, FieldT, Offset >

Builds OneSidedDiv operator type from field type.

Author
Derek Cline, James C. Sutherland
Template Parameters
Opthe basic operator type (e.g., Gradient, Interpolant)
StencilTthe stencil structure (e.g., OneSidedStencil3<IndexTriplet<0,-1,0>)
FieldTthe field that the operator applies to (e.g., SVolField)
Offsetthe offset for the stencil. <0,0,0> (default) results in a one-sided stencil that computes into the first stencil point. <1,0,0> would offset the stencil so that it effectively computes into the <-1,0,0> point.
Example Usage
The following obtains the full type for a two-point, one-sided stencil shifted in the (-z) direction:
typedef OneSidedOpTypeBuilder<Gradient,OneSidedStencil2<ZMinus>,SVolField>::type OneSidedDiv2Z;

Note that we only provide fully specialized versions of this template so that unsupported operator types cannot be inadvertently formed.

Definition at line 115 of file OneSidedOperatorTypes.h.


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