SpatialOps
StencilBuilder.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 The University of Utah
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to
6  * deal in the Software without restriction, including without limitation the
7  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8  * sell copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20  * IN THE SOFTWARE.
21  */
22 
23 #ifndef SpatialOps_structured_StencilBuilder_h
24 #define SpatialOps_structured_StencilBuilder_h
25 
30 namespace SpatialOps{
31 
32  class OperatorDatabase; // forward declaration
33  class Grid; // forward declaration
34 
56  void build_stencils( const unsigned int nx,
57  const unsigned int ny,
58  const unsigned int nz,
59  const double Lx,
60  const double Ly,
61  const double Lz,
62  OperatorDatabase& opdb );
63 
74  void build_stencils( const Grid& grid, OperatorDatabase& opDB );
75 
76 } // namespace SpatialOps
77 
78 #endif // SpatialOps_structured_StencilBuilder_h
void build_stencils(const unsigned int nx, const unsigned int ny, const unsigned int nz, const double Lx, const double Ly, const double Lz, OperatorDatabase &opdb)
builds commonly used stencil operators