www.mooseframework.org
C1ICBase.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
3 /* */
4 /* All contents are licensed under LGPL V2.1 */
5 /* See LICENSE for full restrictions */
6 /****************************************************************/
7 #ifndef C1ICBASE_H
8 #define C1ICBASE_H
9 
10 // Portions of this code Copyright 2007-2009 Roy Stogner
11 //
12 // Permission is hereby granted, free of charge, to any person obtaining
13 // a copy of this software and associated documentation files (the
14 //"Software"), to deal in the Software without restriction, including
15 // without limitation the rights to use, copy, modify, merge, publish,
16 // distribute, sublicense, and/or sell copies of the Software, and to
17 // permit persons to whom the Software is furnished to do so, subject to
18 // the following conditions:
19 //
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23 // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
24 // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
25 // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
26 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 
28 #include "Kernel.h"
29 #include "InitialCondition.h"
30 
31 // System includes
32 #include <string>
33 
34 // Forward Declarations
35 class C1ICBase;
36 
37 template <>
38 InputParameters validParams<C1ICBase>();
39 
43 class C1ICBase : public InitialCondition
44 {
45 public:
46  C1ICBase(const InputParameters & parameters);
47 
48 protected:
49  Real _average;
50  Real _amplitude;
51  Real _length;
52  Real _width;
53  Real _buffer;
54  Real _interface;
55 
56  Number interfaceValue(Real r);
57  Number interfaceDerivative(Real r);
58 };
59 
60 #endif // C1ICBASE_H
Real _interface
Definition: C1ICBase.h:54
Number interfaceDerivative(Real r)
Definition: C1ICBase.C:68
InputParameters validParams< C1ICBase >()
Definition: C1ICBase.C:29
Real _average
Definition: C1ICBase.h:49
Real _length
Definition: C1ICBase.h:51
C1ICBase is used by the CrossIC.
Definition: C1ICBase.h:43
Real _amplitude
Definition: C1ICBase.h:50
Number interfaceValue(Real r)
Definition: C1ICBase.C:55
C1ICBase(const InputParameters &parameters)
Definition: C1ICBase.C:43
Real _width
Definition: C1ICBase.h:52
Real _buffer
Definition: C1ICBase.h:53