NeumannPoissonEBBC.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 _NEUMANNPOISSONEBBC_H_
#define _NEUMANNPOISSONEBBC_H_

#include "RefCountedPtr.H"

#include "BaseEBBC.H"
#include "BaseBCValue.H"
#include "NamespaceHeader.H"

///
/**
 */
class NeumannPoissonEBBC: public BaseEBBC
{
public:
  ///
  /**
   */
  virtual void define(const LayoutData<IntVectSet>& a_cfivs,
                      const Real&                   a_factor)
  {
    ;
    //no flux stencil for Neumann
  }

  void applyEBFluxPoint(const VolIndex&               a_vof,
                        EBCellFAB&                    a_lphi,
                        const EBCellFAB&              a_phi,
                        VoFIterator&                  a_vofit,
                        const LayoutData<IntVectSet>& a_cfivs,
                        const DataIndex&              a_dit,
                        const RealVect&               a_probLo,
                        const RealVect&               a_dx,
                        const Real&                   a_factor,
                        const bool&                   a_useHomogeneous,
                        const Real&                   a_time);

  virtual void applyEBFlux(EBCellFAB&                    a_lphi,
                           const EBCellFAB&              a_phi,
                           VoFIterator&                  a_vofit,
                           const LayoutData<IntVectSet>& a_cfivs,
                           const DataIndex&              a_dit,
                           const RealVect&               a_probLo,
                           const RealVect&               a_dx,
                           const Real&                   a_factor,
                           const bool&                   a_useHomogeneous,
                           const Real&                   a_time);
    ///
  /**
   */
  NeumannPoissonEBBC(const ProblemDomain& a_domain,
                     const EBISLayout&    a_layout,
                     const RealVect&      a_dx);

  //no homogeneous stencil.
  virtual LayoutData<BaseIVFAB<VoFStencil> >* getFluxStencil(int ivar)
  {
    return NULL;
  }
  ///
  /**
   */
  virtual ~NeumannPoissonEBBC();

  ///
  /**
   */
  virtual void setValue(Real a_value);

  ///
  /**
     0 Neumann
     1 Dirichlet
     Anything else is invalid
  */
  virtual int whichBC()
  {
    return 0;
  };

  ///
  /**
   */
  virtual void setFunction(RefCountedPtr<BaseBCValue> a_flux);

  ///
  /**
     deprecated
   */
  virtual void getEBFlux(Real&                         a_flux,
                         const VolIndex&               a_vof,
                         const LevelData<EBCellFAB>&   a_phi,
                         const LayoutData<IntVectSet>& a_cfivs,
                         const DataIndex&              a_dit,
                         const RealVect&               a_probLo,
                         const RealVect&               a_dx,
                         const bool&                   a_useHomogeneous,
                         const Real&                   a_time,
                         const pair<int,Real>*         a_cacheHint=0 );

public:
  bool m_onlyHomogeneous;
  bool m_isFunction;

  Real m_value;
  RefCountedPtr<BaseBCValue> m_flux;

  static int s_comp;
};

///
/**
 */
class NeumannPoissonEBBCFactory: public BaseEBBCFactory
{
public:
  ///
  /**
   */
  NeumannPoissonEBBCFactory();

  ///
  /**
   */
  virtual ~NeumannPoissonEBBCFactory();

  ///
  /**
   */
  virtual void setValue(Real a_value);

  ///
  /**
   */
  virtual void setFunction(RefCountedPtr<BaseBCValue> a_flux);

  virtual void setData( RefCountedPtr<LevelData<BaseIVFAB<Real> > >& a_data)
  {
    m_data = a_data;
    m_dataBased = true;
  }

  ///
  /**
   */
  virtual NeumannPoissonEBBC* create(const ProblemDomain& a_domain,
                                     const EBISLayout&    a_layout,
                                     const RealVect&      a_dx,
                                     const IntVect*       a_ghostCellsPhi=0,
                                     const IntVect*       a_ghostCellsRhs=0);

private:
  bool m_onlyHomogeneous;
  bool m_isFunction;

  Real m_value;
  RefCountedPtr<BaseBCValue> m_flux;

  RefCountedPtr<LevelData<BaseIVFAB<Real> > >  m_data;
  bool m_dataBased;
};

#include "NamespaceFooter.H"
#endif