Loading [MathJax]/extensions/tex2jax.js
Cardinal
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
CartesianGrid.h
Go to the documentation of this file.
1/********************************************************************/
2/* SOFTWARE COPYRIGHT NOTIFICATION */
3/* Cardinal */
4/* */
5/* (c) 2021 UChicago Argonne, LLC */
6/* ALL RIGHTS RESERVED */
7/* */
8/* Prepared by UChicago Argonne, LLC */
9/* Under Contract No. DE-AC02-06CH11357 */
10/* With the U. S. Department of Energy */
11/* */
12/* Prepared by Battelle Energy Alliance, LLC */
13/* Under Contract No. DE-AC07-05ID14517 */
14/* With the U. S. Department of Energy */
15/* */
16/* See LICENSE for full restrictions */
17/********************************************************************/
18
19#pragma once
20
21#include "AuxKernel.h"
22
28class CartesianGrid : public AuxKernel
29{
30public:
31 CartesianGrid(const InputParameters & parameters);
32
33 static InputParameters validParams();
34
35protected:
36 virtual Real computeValue();
37
39 const unsigned int & _nx;
40
42 const unsigned int & _ny;
43
45 const unsigned int & _nz;
46
48 const Real & _shift;
49
51 Real _dx;
52
54 Real _dy;
55
57 Real _dz;
58
60 Point _min;
61};
Definition CartesianGrid.h:29
Real _dx
Width of x regions.
Definition CartesianGrid.h:51
static InputParameters validParams()
Definition CartesianGrid.C:25
const unsigned int & _nx
Number of divisions along x direction.
Definition CartesianGrid.h:39
const unsigned int & _nz
Number of divisions along z direction.
Definition CartesianGrid.h:45
const unsigned int & _ny
Number of divisions along y direction.
Definition CartesianGrid.h:42
virtual Real computeValue()
Definition CartesianGrid.C:52
const Real & _shift
Optional shift to add to each bin index.
Definition CartesianGrid.h:48
Point _min
Lower left of bounding box over mesh.
Definition CartesianGrid.h:60
Real _dz
Width of z regions.
Definition CartesianGrid.h:57
Real _dy
Width of y regions.
Definition CartesianGrid.h:54