GhostBC.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  V \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
// CHOMBO Copyright (c) 2000-2004, The Regents of the University of
// California, through Lawrence Berkeley National Laboratory (subject to
// receipt of any required approvals from U.S. Dept. of Energy).  All
// rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// (2) Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// (3) Neither the name of Lawrence Berkeley National Laboratory, U.S.
// Dept. of Energy nor the names of its contributors may be used to endorse
// or promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
// PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
// OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// You are under no obligation whatsoever to provide any bug fixes,
// patches, or upgrades to the features, functionality or performance of
// the source code ("Enhancements") to anyone; however, if you choose to
// make your Enhancements available either publicly, or directly to
// Lawrence Berkeley National Laboratory, without imposing a separate
// written license agreement for such Enhancements, then you hereby grant
// the following license: a non-exclusive, royalty-free perpetual license
// to install, use, modify, prepare derivative works, incorporate into
// other computer software, distribute, and sublicense such Enhancements or
// derivative works thereof, in binary and source code form.
//
// TRADEMARKS. Product and company names mentioned herein may be the
// trademarks of their respective owners.  Any rights not expressly granted
// herein are reserved.
//

// DTGraves, Mon, July 19, 1999

#ifndef _GHOSTBC_H_
#define _GHOSTBC_H_

#include "Box.H"
#include "FArrayBox.H"
#include "REAL.H"
#include "SPACE.H"
#include "List.H"
#include "Tuple.H"

#include "Interval.H"
#include "Vector.H"
#include "LoHiSide.H"
#include "ProblemDomain.H"


class BoxGhostBC
{
public:
  friend class DomainGhostBC;

  BoxGhostBC()
    :
    m_components(-1,-1)
  {
  }

  virtual ~BoxGhostBC()
  {
  }

  BoxGhostBC(int            a_dir,
             Side::LoHiSide a_sd);

  BoxGhostBC(int             a_dir,
             Side::LoHiSide  a_sd,
             const Interval& a_comps);

protected:
  virtual BoxGhostBC* new_boxghostbc() const = 0;

  void define(int            a_dir,
              Side::LoHiSide a_sd);


  void define(int             a_dir,
              Side::LoHiSide  a_sd,
              const Interval& a_comps);


  virtual void applyInhomogeneousBCs(FArrayBox& a_state,
                                     const Box& a_domain,
                                     Real       a_dx) const;


  virtual void applyHomogeneousBCs(FArrayBox& a_state,
                                   const Box& a_domain,
                                   Real       a_dx) const;


  virtual void applyInhomogeneousBCs(FArrayBox&           a_state,
                                     const ProblemDomain& a_domain,
                                     Real                 a_dx) const;


  virtual void applyHomogeneousBCs(FArrayBox&           a_state,
                                   const ProblemDomain& a_domain,
                                   Real                 a_dx) const;


  virtual void fillBCValues(FArrayBox& a_neumfac,
                            FArrayBox& a_dircfac,
                            FArrayBox& a_inhmval,
                            Real       a_dx,
                            const Box& a_domain) const = 0;


  virtual void applyBCs(const Box&       a_bcbox,
                        FArrayBox&       a_state,
                        const FArrayBox& a_neumfac,
                        const FArrayBox& a_dircfac,
                        const FArrayBox& a_inhmval,
                        Real             a_dx) const;


  virtual void fillBCValues(FArrayBox&           a_neumfac,
                            FArrayBox&           a_dircfac,
                            FArrayBox&           a_inhmval,
                            Real                 a_dx,
                            const ProblemDomain& a_domain) const = 0;

  Side::LoHiSide m_side;

  int m_direction;

  Interval m_components;

private:
  BoxGhostBC(const BoxGhostBC&)
    :
    m_components(-1,-1)
  {
  }

  virtual void operator=(const BoxGhostBC&)
  {
  }
};


class DomainGhostBC
{
public:
  DomainGhostBC();

  ~DomainGhostBC();


  void setBoxGhostBC(const BoxGhostBC& a_ghostBC);

  const List<BoxGhostBC*>& operator()(int            a_direction,
                                      Side::LoHiSide a_side) const;


  void applyHomogeneousBCs(FArrayBox& a_state,
                           const Box& a_domain,
                           Real       a_dx) const;


  void applyHomogeneousBCs(FArrayBox&           a_state,
                           const ProblemDomain& a_domain,
                           Real                 a_dx) const;


  void applyInhomogeneousBCs(FArrayBox& a_state,
                             const Box& a_domain,
                             Real       a_dx) const;


  void applyInhomogeneousBCs(FArrayBox&           a_state,
                             const ProblemDomain& a_domain,
                             Real                 a_dx) const;

  DomainGhostBC& operator=(const DomainGhostBC& a_dgbcin);

  DomainGhostBC(const DomainGhostBC& a_dgbcin);

protected:
  bool isBCDefined(const int            a_dir,
                   const Side::LoHiSide a_side) const;

  void resetBoxGhostBC(const int            a_dir,
                       const Side::LoHiSide a_side);

  Tuple<List<BoxGhostBC*>, SpaceDim> m_loGhostBC;
  Tuple<List<BoxGhostBC*>, SpaceDim> m_hiGhostBC;

private:
};

#endif

---