Chombo + EB + MF  3.2
BoxCollapser.H
Go to the documentation of this file.
1 #ifdef CH_LANG_CC
2 /*
3  * _______ __
4  * / ___/ / ___ __ _ / / ___
5  * / /__/ _ \/ _ \/ V \/ _ \/ _ \
6  * \___/_//_/\___/_/_/_/_.__/\___/
7  * Please refer to Copyright.txt, in Chombo's root directory.
8  */
9 #endif
10 
11 #ifndef _BOXCOLLAPSER_H_
12 #define _BOXCOLLAPSER_H_
13 
14 #include "BoxLayout.H" // contains BaseTransform
15 #include "Interval.H"
16 
17 #include "NamespaceHeader.H"
18 
19 /// This class collapses the "fixed" dimensions of a Box to its small end.
20 
22 {
23 public:
24 
25  /**
26  \name Constructor, destructor, and defines.
27  */
28  /*@{*/
29 
30  ///
31  /** Constructor.
32  */
33  BoxCollapser(const Interval& a_fixedDims);
34 
35  /** destructor
36  */
37  virtual ~BoxCollapser();
38 
39  /** Required for BaseTransform.
40  Returns the collapsed Box:
41  the range in a_fixedDims is set to a_inputBox.smallEnd() only.
42  */
43  virtual Box operator() (const Box& a_inputBox);
44 
45 protected:
46 
48 };
49 
50 #include "NamespaceFooter.H"
51 #endif
Base class to transform boxes in an existing layout.
Definition: BoxLayout.H:48
virtual ~BoxCollapser()
This class collapses the "fixed" dimensions of a Box to its small end.
Definition: BoxCollapser.H:21
Structure for passing component ranges in code.
Definition: Interval.H:23
A Rectangular Domain on an Integer Lattice.
Definition: Box.H:469
Interval m_fixedDims
Definition: BoxCollapser.H:47
BoxCollapser(const Interval &a_fixedDims)
virtual Box operator()(const Box &a_inputBox)