PhysBCUtil.H

Go to the documentation of this file.

/* _______              __
  / ___/ /  ___  __ _  / /  ___
 / /__/ _ \/ _ \/  ' \/ _ \/ _ \
 \___/_//_/\___/_/_/_/_.__/\___/ 
*/

// PhysBCUtil.H

//
// 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.
//
// Dan Martin, Fri, Jan 14, 2000

#ifndef _PhysBCUtil_H_
#define _PhysBCUtil_H_

#include "GhostBC.H"
#include "Tuple.H"
#include "ParmParse.H"
#include "LoHiSide.H"
#include "basicVelBC.H"

// include support for *IBC stuff from AMRGodunov, for use with
// PatchGodunov-derived stuff
#ifdef NEW_ADVECTION
#include "PhysIBC.H"
#endif



class PhysBCUtil
{

public:
  /*@ManMemo: this will access the ParmParse database using the
    physBC prefix and use it to define the physical BC types (hi 
    and lo) in each direction.  The BC type "custom" will imply
    that the BC is a somewhat nonstandard one, but that the 
    derived class will know what to do with it. */
  PhysBCUtil();

  virtual ~PhysBCUtil();

  enum BCType {
    bogusBC = -1,
    SolidWall,
    Inflow,
    Outflow, 
    Symmetry,
    noShear,
    Custom,
    NUM_PHYS_BC_TYPES};



  virtual PhysBCUtil* newPhysBCUtil() const;


  virtual DomainGhostBC* MacPressureBC() const;

  virtual DomainGhostBC* gradMacPressureBC() const;

  virtual DomainGhostBC* LevelPressureBC() const;

  virtual DomainGhostBC* gradPiBC() const;

  virtual DomainGhostBC* SyncProjBC() const;

  virtual DomainGhostBC* gradESyncBC() const;

  virtual DomainGhostBC* FreestreamCorrBC() const;

  virtual DomainGhostBC* gradELambdaBC() const;

  virtual DomainGhostBC* InitialProjBC() const;

  virtual DomainGhostBC* gradInitialProjCorrBC() const;

  
  
  virtual basicVelBC* viscousVelBC() const;

  virtual basicVelBC* tracingVelBC() const;

  virtual basicEdgeVelBC* advectionVelBC() const;

  virtual basicEdgeVelBC* edgeVelBC() const;

  virtual basicVelBC* uDelUBC(bool a_isViscous) const;

  virtual DomainGhostBC* viscousSolveBC(int a_dir) const;

  virtual basicVelBC* uStarBC(bool a_isViscous = true) const;
  
  virtual DomainGhostBC* viscousRefluxBC(int a_dir) const;

#ifdef NEW_ADVECTION

  virtual PhysIBC* advectionVelIBC() const;
#endif


  virtual DomainGhostBC* diffusiveBC(int a_scalarType) const;

  virtual DomainGhostBC* scalarTraceBC(int a_scalarType) const;
  
  virtual DomainGhostBC* scalarDiffusionSolveBC(int a_scalarType) const;

  virtual DomainGhostBC* scalarRefluxSolveBC(int a_scalarType) const;

#ifdef NEW_ADVECTION

  virtual PhysIBC* scalarTraceIBC(int a_scalarType) const;
#endif

  virtual DomainGhostBC* lambdaBC() const;

#ifdef NEW_ADVECTION

  virtual PhysIBC* lambdaTraceIBC() const;
#endif


  virtual basicVelBC* viscousSrcBC() const;

  virtual basicVelBC* diffusiveSrcBC(int scalarType) const;

  // BC on stream function (used when computing stream func. from vorticity)
  virtual DomainGhostBC* streamFunctionBC(const Interval& a_comps) const;



  void Dx(const Real a_dx);

  Real Dx() const;

  void Time(const Real a_time);

  Real Time() const;

  int loBC(int a_dir) const;
  
  int hiBC(int a_dir) const;

  int getBC(int a_dir, const Side::LoHiSide& a_side) const;


  virtual void computeBoundaryDt(Real& a_dt, Real a_cfl, Real a_dx) const;




protected:
  virtual DomainGhostBC* basicPressureBC(bool a_isHomogeneous) const;
  

  virtual DomainGhostBC* basicGradPressureBC() const;

  virtual basicVelBC* basicCCVelBC(bool a_isHomogeneous,
                                   bool a_isViscous) const;


  virtual void basicCCVelBC(DomainGhostBC& a_newBC,
                            bool a_isHomogeneous,
                            bool a_isViscous,
                            int a_velComponent,
                            Interval& a_interval) const;
  
  
  virtual basicEdgeVelBC* basicECVelBC(bool a_isHomogeneous,
                                       bool a_isViscous,
                                       bool a_isSingleComponent) const;

  
  virtual DomainGhostBC* basicScalBC(bool a_isHomogeneous,
                                     int a_scalType) const;

  virtual void setBCs();

  // contains the enumerated values for the lo-end BC
  Tuple<int, SpaceDim> m_loBC;

  // contains the enumerated values for the hi-end BC
  Tuple<int, SpaceDim> m_hiBC;


private:
  Real m_dx;

  Real m_time;

  PhysBCUtil(const PhysBCUtil& rhs);

  virtual PhysBCUtil& operator=(const PhysBCUtil& rhs);



};

#endif

---