Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

CFStencil.H

Go to the documentation of this file.
00001 /*   _______              __
00002     / ___/ /  ___  __ _  / /  ___
00003    / /__/ _ \/ _ \/  V \/ _ \/ _ \
00004    \___/_//_/\___/_/_/_/_.__/\___/
00005 */
00006 // CHOMBO Copyright (c) 2000-2004, The Regents of the University of
00007 // California, through Lawrence Berkeley National Laboratory (subject to
00008 // receipt of any required approvals from U.S. Dept. of Energy).  All
00009 // rights reserved.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are met:
00013 //
00014 // (1) Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 // (2) Redistributions in binary form must reproduce the above copyright
00017 // notice, this list of conditions and the following disclaimer in the
00018 // documentation and/or other materials provided with the distribution.
00019 // (3) Neither the name of Lawrence Berkeley National Laboratory, U.S.
00020 // Dept. of Energy nor the names of its contributors may be used to endorse
00021 // or promote products derived from this software without specific prior
00022 // written permission.
00023 //
00024 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00025 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
00026 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00027 // PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
00028 // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00029 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00030 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00031 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00032 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00033 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00034 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035 //
00036 // You are under no obligation whatsoever to provide any bug fixes,
00037 // patches, or upgrades to the features, functionality or performance of
00038 // the source code ("Enhancements") to anyone; however, if you choose to
00039 // make your Enhancements available either publicly, or directly to
00040 // Lawrence Berkeley National Laboratory, without imposing a separate
00041 // written license agreement for such Enhancements, then you hereby grant
00042 // the following license: a non-exclusive, royalty-free perpetual license
00043 // to install, use, modify, prepare derivative works, incorporate into
00044 // other computer software, distribute, and sublicense such Enhancements or
00045 // derivative works thereof, in binary and source code form.
00046 //
00047 // TRADEMARKS. Product and company names mentioned herein may be the
00048 // trademarks of their respective owners.  Any rights not expressly granted
00049 // herein are reserved.
00050 //
00051 
00052 #ifndef _CFSTENCIL_H_
00053 #define _CFSTENCIL_H_
00054 
00055 #include <iostream>
00056 #include <math.h>
00057 #include "SPACE.H"
00058 #include <stdlib.h>
00059 #include "DisjointBoxLayout.H"
00060 #include "Box.H"
00061 #include "LoHiSide.H"
00062 #include "IntVectSet.H"
00063 
00065 
00071 class CFStencil
00072 {
00073 
00074 private:
00075 
00076 protected:
00077   //for internal use
00078   void  setDefaultValues();
00079 
00080   //the following variables are mainly for self-identification
00081 
00082   // direction normal to interface
00083   int m_direction;
00084 
00085   // interface is on high or low side of grid
00086   Side::LoHiSide m_hiorlo;
00087 
00088   //
00089   DataIndex m_dataIndex;
00090 
00091   //the following variables are to be used by others
00092 
00093   /* fine intvects which need to be interpolated */
00094   IntVectSet m_fineIVS;
00095 
00096   /* coar intvects where slopes can be computed
00097       == coarsened version of fiinterp ivs*/
00098   IntVectSet m_coarIVS;
00099 
00100   bool m_isDefined;
00101 
00102 public:
00104 
00106 
00107   bool isDefined() const;
00108 
00110 
00113   bool isEmpty() const;
00114 
00116 
00118   const IntVectSet& getFineIVS() const ;
00119 
00121 
00125   const IntVectSet& getCoarIVS() const ;
00126 
00128   CFStencil& operator= (const CFStencil& cfs_in);
00129 
00131   CFStencil(const CFStencil& cfs_in);
00132 
00133   /*dummy constructor so i can use this with
00134      LocalBoxLayoutData
00135    */
00136   CFStencil(const Box& a_b, int a_nComp);
00137 
00138   void define(const Box& a_b, int a_nComp);
00139 
00141   CFStencil();
00142 
00144   ~CFStencil();
00145 
00147   CFStencil(
00148             const Box& FineDomain,
00149             const Box& grid,
00150             const DisjointBoxLayout& Levboxes,
00151             const DisjointBoxLayout& LevCBoxes,
00152             int RefRatio,
00153             int Direction,
00154             Side::LoHiSide hiorlo);
00155 
00157   CFStencil(
00158             const ProblemDomain& FineDomain,
00159             const Box& grid,
00160             const DisjointBoxLayout& Levboxes,
00161             const DisjointBoxLayout& LevCBoxes,
00162             int RefRatio,
00163             int Direction,
00164             Side::LoHiSide hiorlo);
00165 
00167   void   define(
00168                 const Box& FineDomain,
00169                 const Box& grid,
00170                 const DisjointBoxLayout& fine_boxes,
00171                 const DisjointBoxLayout& coar_boxes,
00172                 int Refratio,
00173                 int Direction,
00174                 Side::LoHiSide hiorlo);
00175 
00177   void   define(
00178                 const ProblemDomain& FineDomain,
00179                 const Box& grid,
00180                 const DisjointBoxLayout& fine_boxes,
00181                 const DisjointBoxLayout& coar_boxes,
00182                 int Refratio,
00183                 int Direction,
00184                 Side::LoHiSide hiorlo);
00185 
00187   void clear();
00188 
00189 };
00190 #endif

Generated on Wed Oct 5 13:52:08 2005 for Chombo&AMRSelfGravity by  doxygen 1.4.1