SpatialOps
SpatialOps::BCOpTypesFromDirection< FieldT, DirT > Class Template Reference

Given a field type and direction type, this provides type inference to obtain BC operator types to achieve Dirichlet & Neumann BCs. More...

#include <FVStaggeredBCOp.h>

Detailed Description

template<typename FieldT, typename DirT>
class SpatialOps::BCOpTypesFromDirection< FieldT, DirT >

Given a field type and direction type, this provides type inference to obtain BC operator types to achieve Dirichlet & Neumann BCs.

Author
James C. Sutherland
Date
November, 2014
Template Parameters
FieldTthe type of field that we are interested in setting BCs on.
DirTthe direction type that we want to achieve the BC on. This is one of: SpatialOps::XDIR, SpatialOps::YDIR, SpatialOps::ZDIR

The following public typedefs are made:

  • Dirichlet
  • Neumann These correspond to an operator that will achieve Dirichlet and Neumann conditions on FieldT in direction DirT.

Example:

typedef BCOpTypesFromDirection<SVolField,XDIR>::Neumann BCOpT;
BCOpT bcop = *opDB.retrieve_operator<BCOpT>();
bcop( mask, field, bcValue ); // set bcValue by inverting operator on mask points

Definition at line 145 of file FVStaggeredBCOp.h.


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