---

PolarBL.H

Go to the documentation of this file.

/* _______              __
  / ___/ /  ___  __ _  / /  ___
 / /__/ _ \/ _ \/  ' \/ _ \/ _ \
 \___/_//_/\___/_/_/_/_.__/\___/ 
*/
//
// This software is copyright (C) by the Lawrence Berkeley
// National Laboratory.  Permission is granted to reproduce
// this software for non-commercial purposes provided that
// this notice is left intact.
// 
// It is acknowledged that the U.S. Government has rights to
// this software under Contract DE-AC03-765F00098 between
// the U.S.  Department of Energy and the University of
// California.
//
// This software is provided as a professional and academic
// contribution for joint exchange. Thus it is experimental,
// is provided ``as is'', with no warranties of any kind
// whatsoever, no support, no promise of updates, or printed
// documentation. By using this software, you acknowledge
// that the Lawrence Berkeley National Laboratory and
// Regents of the University of California shall have no
// liability with respect to the infringement of other
// copyrights by any part of this software.
//
//  ANAG, LBNL, DTG

#ifndef _PolarBL_H_
#define _PolarBL_H_

#include "MayDay.H"
#include "LoHiSide.H"
#include "IntVect.H"
#include "RealVect.H"
#include "BaseLevelSet.H"
#include "REAL.H"
#include "BoxIterator.H"
using std::pair;

/*
   This is the workshop class for a Polar.
   It follows the BaseLocalGeometry base class.
   Returns C_z+sqrt (radius-(x-C_x)squared+(y-C_y)squared));
 */
class PolarBL: public BaseLevelSet
{
public:

  PolarBL(const Real&         a_coeffA,
          const Real&         a_coeffB,
          const Real&         a_coeffC,
          const RealVect&     a_center,
          const bool&         a_insideRegular,
          const Real&         a_dx);

  virtual ~PolarBL();

  
  /*
      Return true if every cell in region is regular at the
      refinement described by dx.
  */
  virtual bool isRegular(const Box&      region,
                         const Box&      domain,
                         const RealVect& origin,
                         const Real&     dx) const;

  /* 
      Return true if every cell in region is covered at the
      refinement described by dx.
  */
  virtual bool isCovered(const Box&           region,
                         const Box&           domain,
                         const RealVect&      origin,
                         const Real&          dx) const;

  /*
     This returns the signed integer which  most closely
     represents the normal direction.  The first integer
     of the pair is of the interface at an irregular cell
     (which coordinate direction has the largest normal component). 
     This will only be called if the cell is irregular.
   */
   

  virtual
  pair<int, Side::LoHiSide> upDirection(const RealVect& midPt,const IntVect& a_iv) const;

  
  //     Return the value at the dependent coordinate given the independent
  //  coordinates. Returns C_z+sqrt (radius-(x-C_x)squared+(y-C_y)squared));
  //  Where the center is (C_x,C_y,C_z)
   
  
  virtual Real localFuncValue(const RealVect& a_independentCoords, 
                              const int& a_upDirection,
                              const IntVect& a_iv, 
                              const Box& a_domain, 
                              const RealVect& a_origin, 
                              const Real& a_dx) const;  

 
  
  //   Return a newly allocated derived class.  The responsibility
  //  for deleting the memory is left to the calling function.
  
  virtual
  BaseLevelSet* new_baseLevelSet() const;   
  // calculates the max coordiante of a RealVect
  virtual Real maxabs(const RealVect& vec)const;
  // calculates the magnitude of a RealVect
  virtual Real magnitude(const RealVect& vec)const;
  // a polar equation
  virtual Real star(const RealVect& vec)const;
  virtual Real starX(const RealVect& vec)const;
  virtual Real starY(const RealVect& vec)const;
  virtual Real star(const Real x, Real y)const;
protected:
  Real m_coeffA;
  Real m_coeffB;
  Real m_coeffC;
  RealVect m_center;
  bool m_insideRegular;
  Real m_dx;


private:
  PolarBL()
  {
    MayDay::Error("PolarBL uses strong construction");
  }
  PolarBL(const PolarBL& a_center)
  {
    MayDay::Error("PolarBL disallows copy construction");
  }
  void operator=(const PolarBL& a_center)
  {
    MayDay::Error("PolarBL disallows assignment");
  }

};
#endif

---