BaseIF.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 _BASEIF_H_
#define _BASEIF_H_

#include "RealVect.H"
#include "ProblemDomain.H"
#include "IndexTM.H"

#include "Notation.H"
#include "GeometryService.H"

#include "NamespaceHeader.H"


class BaseIF
{

public:

  BaseIF()
  {
  }

  virtual ~BaseIF()
  {
  }


  virtual Real value(const RealVect& a_point) const = 0;


  virtual bool fastIntersection(const Box&           a_region,
                                const ProblemDomain& a_domain,
                                const RealVect&      a_origin,
                                const Real&          a_dx) const
  {
    RealVect low, high;
    corners(a_region, a_origin, a_dx, low, high);
    return fastIntersection(low, high);
  }

  virtual bool fastIntersection(const RealVect& a_low,
                                const RealVect& a_high) const
  {return false;}

  virtual GeometryService::InOut InsideOutside(const Box&           a_region,
                                               const ProblemDomain& a_domain,
                                               const RealVect&      a_origin,
                                               const Real&          a_dx) const
  {
    RealVect low, high;
    corners(a_region, a_origin, a_dx, low, high);
    return InsideOutside(low, high);
  }

  virtual GeometryService::InOut InsideOutside(const RealVect& a_low,
                                               const RealVect& a_high) const

  {
    MayDay::Error("This class has not implemented a fastIntersection operation");
    return GeometryService::Irregular;
  }

  virtual Real value(const IndexTM<Real,GLOBALDIM>& a_point) const
  {
    MayDay::Abort("'value' called with 'IndexTM' not implemented in BaseIF");
    Real retval = LARGEREALVAL;
    return retval;
  };


  virtual IndexTM<Real,GLOBALDIM> grad(const IndexTM<Real,GLOBALDIM>& a_point) const
  {
    MayDay::Abort("'grad' not implemented in BaseIF");
    return IndexTM<Real,GLOBALDIM>();
  };


  virtual IndexTM<Real,GLOBALDIM> normal(const IndexTM<Real,GLOBALDIM>& a_point) const
  {
    MayDay::Abort("'normal' not implemented in BaseIF");
    return IndexTM<Real,GLOBALDIM>();
  };


  virtual Vector<IndexTM <Real,GLOBALDIM> > gradGrad(const IndexTM<Real,GLOBALDIM>& a_point) const
  {
    MayDay::Abort("'gradGrad' not implemented in BaseIF");
    return Vector<IndexTM <Real,GLOBALDIM> >();
  };


  virtual Vector<IndexTM <Real,GLOBALDIM> > gradNormal(const IndexTM<Real,GLOBALDIM>& a_point) const
  {
    MayDay::Abort("'gradNormal' not implemented in BaseIF");
    return Vector<IndexTM <Real,GLOBALDIM> >();
  };


  virtual BaseIF* newImplicitFunction() const = 0;


  static void corners(const Box& a_region, const RealVect& a_origin, const Real& a_dx,
                      RealVect& a_lo, RealVect& a_hi)
  {
    a_lo = a_origin + RealVect(a_region.smallEnd())*a_dx;
    a_hi = a_origin + RealVect(a_region.bigEnd()+IntVect::Unit)*a_dx;
  }
};

#include "NamespaceFooter.H"

#endif

---