SpatialOps
SpatialOps::NeboStencilBuilder< OperatorType, PntCltnT, SrcFieldT, DestFieldT > Struct Template Reference

Supports definition of new Nebo stencils. More...

#include <NeboStencilBuilder.h>

Classes

struct  WithArg
 

Public Types

typedef OperatorType type
 operator type (Interpolant, Gradient, Divergence)
 
typedef PntCltnT PointCollectionType
 collection of stencil points
 
typedef SrcFieldT SrcFieldType
 source field type
 
typedef DestFieldT DestFieldType
 destination field type
 
typedef NeboStencilCoefCollection< PointCollectionType::length > CoefCollection
 collection of coefficients
 

Public Member Functions

 NeboStencilBuilder (const CoefCollection &coefs)
 construct a stencil with the specified coefficients
 
CoefCollection const & coefs (void) const
 Return coefficient collection.
 
void apply_to_field (const SrcFieldType &src, DestFieldType &dest) const
 Apply this operator to the supplied source field to produce the supplied destination field. More...
 
FieldResult operator() (const SrcFieldType &src) const
 Nebo's inline operator for field values. More...
 
template<typename Arg >
WithArg< Arg >::Result operator() (const NeboExpression< Arg, SrcFieldType > &src) const
 Nebo's inline operator for Nebo expressions. More...
 

Detailed Description

template<typename OperatorType, typename PntCltnT, typename SrcFieldT, typename DestFieldT>
struct SpatialOps::NeboStencilBuilder< OperatorType, PntCltnT, SrcFieldT, DestFieldT >

Supports definition of new Nebo stencils.

Template Parameters
OperatorTypethe type of operator, e.g. SpatialOps::Gradient, SpatialOps::Interpolant, etc.
PntCltnTdefines the stencil points
SrcFieldTthe type of field that this operator acts on
DestFieldTthe type of field that this operator produces

Definition at line 86 of file NeboStencilBuilder.h.

Member Function Documentation

◆ apply_to_field()

template<typename OperatorType , typename PntCltnT , typename SrcFieldT , typename DestFieldT >
void SpatialOps::NeboStencilBuilder< OperatorType, PntCltnT, SrcFieldT, DestFieldT >::apply_to_field ( const SrcFieldType src,
DestFieldType dest 
) const
inline

Apply this operator to the supplied source field to produce the supplied destination field.

Parameters
srcthe field that the operator is applied to
destthe resulting field.

Definition at line 126 of file NeboStencilBuilder.h.

◆ operator()() [1/2]

template<typename OperatorType , typename PntCltnT , typename SrcFieldT , typename DestFieldT >
FieldResult SpatialOps::NeboStencilBuilder< OperatorType, PntCltnT, SrcFieldT, DestFieldT >::operator() ( const SrcFieldType src) const
inline

Nebo's inline operator for field values.

Parameters
srcthe field to which the operator is applied

Definition at line 134 of file NeboStencilBuilder.h.

◆ operator()() [2/2]

template<typename OperatorType , typename PntCltnT , typename SrcFieldT , typename DestFieldT >
template<typename Arg >
WithArg<Arg>::Result SpatialOps::NeboStencilBuilder< OperatorType, PntCltnT, SrcFieldT, DestFieldT >::operator() ( const NeboExpression< Arg, SrcFieldType > &  src) const
inline

Nebo's inline operator for Nebo expressions.

Parameters
srcthe Nebo expression to which the operator is applied

Definition at line 144 of file NeboStencilBuilder.h.


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