www.mooseframework.org
CrossIC.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 // Portions of this code Copyright 2007-2009 Roy Stogner
13 //
14 // Permission is hereby granted, free of charge, to any person obtaining
15 // a copy of this software and associated documentation files (the
16 //"Software"), to deal in the Software without restriction, including
17 // without limitation the rights to use, copy, modify, merge, publish,
18 // distribute, sublicense, and/or sell copies of the Software, and to
19 // permit persons to whom the Software is furnished to do so, subject to
20 // the following conditions:
21 //
22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25 // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
26 // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
27 // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
28 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 
30 #include "InitialCondition.h"
31 #include "C1ICBase.h"
32 
33 // Forward Declarations
34 class CrossIC;
35 
36 template <>
37 InputParameters validParams<CrossIC>();
38 
43 class CrossIC : public C1ICBase
44 {
45 public:
46  CrossIC(const InputParameters & parameters);
47 
48  virtual Real value(const Point & p);
49  virtual RealGradient gradient(const Point & p);
50 
51  const Real _x1;
52  const Real _y1;
53  const Real _x2;
54  const Real _y2;
55 };
56 
CrossIC::gradient
virtual RealGradient gradient(const Point &p)
Definition: CrossIC.C:269
libMesh::RealGradient
VectorValue< Real > RealGradient
Definition: GrainForceAndTorqueInterface.h:17
validParams< CrossIC >
InputParameters validParams< CrossIC >()
Definition: CrossIC.C:34
CrossIC
CrossIC creates a C1 continuous initial condition that looks like a cross in the middle of the domain...
Definition: CrossIC.h:43
C1ICBase.h
CrossIC::_y2
const Real _y2
Definition: CrossIC.h:54
CrossIC::value
virtual Real value(const Point &p)
Definition: CrossIC.C:55
CrossIC::CrossIC
CrossIC(const InputParameters &parameters)
Definition: CrossIC.C:45
CrossIC::_x1
const Real _x1
Definition: CrossIC.h:51
C1ICBase
C1ICBase is used by the CrossIC.
Definition: C1ICBase.h:45
CrossIC::_x2
const Real _x2
Definition: CrossIC.h:53
CrossIC::_y1
const Real _y1
Definition: CrossIC.h:52