SpatialOps
SpatialOps::FieldFunction3D< FieldT, PatchT > Class Template Referenceabstract

Supports implementation of 3D functions to assign values to SpatialField objects. More...

#include <FieldFunctions.h>

Protected Member Functions

 FieldFunction3D (const FieldT &x, const FieldT &y, const FieldT &z)
 
 FieldFunction3D (PatchT &p, const FieldID xid, const FieldID yid, const FieldID zid)
 
void set_fields () const
 

Detailed Description

template<typename FieldT, typename PatchT = FFLocal::NULLPatch>
class SpatialOps::FieldFunction3D< FieldT, PatchT >

Supports implementation of 3D functions to assign values to SpatialField objects.

Author
James C. Sutherland
Date
September, 2007
Template Parameters
  • FieldT The type of field that this function applies to.

  • PatchT The patch type (if applicable) that this field lives on. If no patch is specified, then field references for the spatial coordinates must be provded at construction.

    PatchT must define the FieldID type for field identifiers. It must also provide access to FieldManager objects.

    Note that PatchT is an optional template parameter. In the case where a patch is not being used, or where field references are available at construction, this template parameter may be omitted.

Definition at line 82 of file FieldFunctions.h.

Constructor & Destructor Documentation

◆ FieldFunction3D() [1/2]

template<typename FieldT , typename PatchT >
SpatialOps::FieldFunction3D< FieldT, PatchT >::FieldFunction3D ( const FieldT &  x,
const FieldT &  y,
const FieldT &  z 
)
protected

Use this constructor when the PatchT was not specified.

Definition at line 478 of file FieldFunctions.h.

◆ FieldFunction3D() [2/2]

template<typename FieldT , typename PatchT >
SpatialOps::FieldFunction3D< FieldT, PatchT >::FieldFunction3D ( PatchT &  p,
const FieldID  xid,
const FieldID  yid,
const FieldID  zid 
)
protected

Use this constructor when the PatchT was specified.

Definition at line 485 of file FieldFunctions.h.

Member Function Documentation

◆ set_fields()

template<typename FieldT , typename PatchT >
void SpatialOps::FieldFunction3D< FieldT, PatchT >::set_fields ( ) const
protected

In the case where field ids were provided and this is built using a patch, then this binds fields. It must be called before using any of the fields.

Definition at line 495 of file FieldFunctions.h.


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