HumpIBC.H

Go to the documentation of this file.

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

//
//  HumpIBC.H
// ============
//
// PhysIBC-derived class for "hump" test case
// (a ellipsoidal hump of ice on a flat plain)


#ifndef _HUMPIBC_H_
#define _HUMPIBC_H_

#include "IceThicknessIBC.H"

#include "NamespaceHeader.H"



class HumpIBC : public IceThicknessIBC
{
public:

  HumpIBC();


  virtual ~HumpIBC();


  virtual void define(const ProblemDomain& a_domain,
                      const Real&          a_dx);

  void setParameters(Real a_maxThickness,
                     Real a_radSqr,
                     Real a_baseElevation,
                     Real a_minThickness,
                     RealVect a_center,
                     const Real& a_seaLevel,
                     const RealVect& a_widthScale = RealVect::Unit);


  virtual IceThicknessIBC* new_thicknessIBC();


  virtual void initialize(LevelData<FArrayBox>& a_U);


  virtual void initializeIceGeometry(LevelSigmaCS& a_coords,
                                     const RealVect& a_dx,
                                     const RealVect& a_domainSize,
                                     const Real& a_time,
                                     const LevelSigmaCS* a_crseCoords,
                                     const int a_refRatio);



  virtual void primBC(FArrayBox&            a_WGdnv,
                      const FArrayBox&      a_Wextrap,
                      const FArrayBox&      a_W,
                      const int&            a_dir,
                      const Side::LoHiSide& a_side,
                      const Real&           a_time);


  virtual
  void setBdrySlopes(FArrayBox&       a_dW,
                     const FArrayBox& a_W,
                     const int&       a_dir,
                     const Real&      a_time);


  virtual
  void artViscBC(FArrayBox&       a_F,
                 const FArrayBox& a_U,
                 const FArrayBox& a_divVel,
                 const int&       a_dir,
                 const Real&      a_time);


  virtual RefCountedPtr<CompGridVTOBC> velocitySolveBC();


  virtual void modifyVelocityRHS(LevelData<FArrayBox>& a_rhs,
                                 LevelSigmaCS& a_coords,
                                 const ProblemDomain& a_domain,
                                 Real a_time, Real a_dt);



  virtual void setSurfaceHeightBCs(LevelData<FArrayBox>& a_zSurface,
                                   LevelSigmaCS& a_coords,
                                   const ProblemDomain& a_domain,
                                   const RealVect& a_dx, 
                                   Real a_time, Real a_dt);

protected:

  Real m_baseElevation;

  Real m_maxThickness;

  // it's easier to work in terms of radius squared...
  Real m_radSqr;

  RealVect m_center;

  // width factor (0 means no variation in that direction)
  RealVect m_widthScale;

  RealVect m_domainSize;

  // thickness of ice outside of hump (normally zero)
  Real m_minThickness;

  Real m_seaLevel;

  // have bc's been set up?
  bool m_isBCsetUp;

  // have parameters been set
  bool m_paramsSet;

  void setupBCs();

  RefCountedPtr<CompGridVTOBC> m_velBCs;

  // do higher-order averaged initial condition (for convergence testing)
  bool m_doHOinit;

private:
  // Disallowed for all the usual reasons
  void operator=(const HumpIBC& a_input)
  {
    MayDay::Error("invalid operator");
  }

  // Disallowed for all the usual reasons
  HumpIBC(const HumpIBC& a_input)
  {
    MayDay::Error("invalid operator");
  }
};

#include "NamespaceFooter.H"
#endif