AggStencil.H

Go to the documentation of this file.

#ifdef CH_LANG_CC
/*
 *      _______              __
 *     / ___/ /  ___  __ _  / /  ___
 *    / /__/ _ \/ _ \/  V \/ _ \/ _ \
 *    \___/_//_/\___/_/_/_/_.__/\___/
 *    Please refer to Copyright.txt, in Chombo's root directory.
 */
#endif

#ifndef _AGGSTENCIL_H_
#define _AGGSTENCIL_H_

#include "Stencils.H"
#include "BaseIndex.H"
#include "Vector.H"
#include "REAL.H"
#include "CH_Timer.H"
#include "RefCountedPtr.H"
#include "NamespaceHeader.H"

/// Aggregated stencil
/**
   srcData_t classes need the following functions
   int   dataType(BaseIndex);
   int     offset(BaseIndex);
   Real* dataPtr(int dataType, int ivar);

   dstData_t classes need the following functions
   int   dataType(BaseIndex);
   int     offset(BaseIndex);
   Real* dataPtr(int dataType, int ivar);

   sten_t classes need the following functions
   srcIndex_t index(int isten)
   Real       weight(int isten)
 */
template <class srcData_t, class dstData_t>
class AggStencil
{
public:
  ///
  /**
     a_dstIndex is where the answers will go.
     a_srcStencil is the stencil into the src data
     a_srcData is to provide offsets for source data (can be a dummy but must be the right size)
     a_dstData is to provide offsets for destin data (can be a dummy but must be the right size)
   */
  AggStencil(const Vector<RefCountedPtr<BaseIndex  > >& a_dstVoFs,
             const Vector<RefCountedPtr<BaseStencil> >& a_stencil,
             const srcData_t                          & a_srcData,
             const dstData_t                          & a_dstData);

  ///
  ~AggStencil()
  {
  }

  ///
  void apply(dstData_t       & a_lph,
             const srcData_t & a_phi,
             const int       & a_varDest,
             const bool      & a_incrementOnly) const;

  ///
  /**
     for applying a scalar operator to multiple operators.
     Sets the initial variable for destination to a_varDest
     Sets dataPtr for a_phi initial variable to a_varSrc
     Runs over ncomp components
   */
  void apply(dstData_t       & a_lph,
             const srcData_t & a_phi,
             const int       & a_src,
             const int       & a_dst,
             const int       & a_nco,
             const bool      & a_incrementOnly) const;

  ///
  void   cache(const dstData_t& a_lph) const;

  ///
  void uncache(      dstData_t& a_phi) const;

  struct
  {
    size_t offset;
    int  dataID;
  } typedef access_t;

  typedef Vector<pair<access_t, Real> > stencil_t;

protected:

  int m_destVar;
  Vector<stencil_t>   m_ebstencil;
  Vector<access_t>    m_dstAccess;
  mutable Vector< Vector<Real> > m_cacheDst;

private:
  /// disallowed operators.   Without code because Jeff says that is better.

  ///weak construction is bad.
  AggStencil();

  ///deep copy for this object would kill performance
  AggStencil& operator=(const AggStencil& stenin);

  ///no reason to allow this one either.
  AggStencil(const AggStencil& stenin);

};

#include "AggStencilI.H"
#include "NamespaceFooter.H"
#endif