SpatialOps
SpatialOps::BCOpTypes< FieldT > Class Template Reference

Provides type inference to obtain BC operator types for a field type. More...

#include <FVStaggeredBCOp.h>

Inheritance diagram for SpatialOps::BCOpTypes< FieldT >:
Collaboration diagram for SpatialOps::BCOpTypes< FieldT >:

Detailed Description

template<typename FieldT>
class SpatialOps::BCOpTypes< FieldT >

Provides type inference to obtain BC operator types for a field type.

Author
James C. Sutherland, Tony Saad
Date
November, 2014

The following public typedefs are made:

Type Description
DirichletX Set ghost value to achieve a desired value on the x-surface
DirichletY Set ghost value to achieve a desired value on the y-surface
DirichletZ Set ghost value to achieve a desired value on the z-surface
NeumannX Set ghost value to achieve a desired derivative on the x-surface
NeumannY Set ghost value to achieve a desired derivative on the y-surface
NeumannZ Set ghost value to achieve a desired derivative on the z-surface

Example:

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

Definition at line 70 of file FVStaggeredBCOp.h.


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