www.mooseframework.org
SmoothCircleBaseIC.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 #include "InitialCondition.h"
13 #include "MooseRandom.h"
14 
15 // Forward Declarations
16 class SmoothCircleBaseIC;
17 
18 template <>
19 InputParameters validParams<SmoothCircleBaseIC>();
20 
26 class SmoothCircleBaseIC : public InitialCondition
27 {
28 public:
29  SmoothCircleBaseIC(const InputParameters & parameters);
30 
31  virtual Real value(const Point & p);
32  virtual RealGradient gradient(const Point & p);
33 
34  virtual void initialSetup();
35 
36 protected:
37  virtual Real computeCircleValue(const Point & p, const Point & center, const Real & radius);
38  virtual RealGradient
39  computeCircleGradient(const Point & p, const Point & center, const Real & radius);
40 
41  virtual void computeCircleRadii() = 0;
42  virtual void computeCircleCenters() = 0;
43 
44  MooseMesh & _mesh;
45 
46  Real _invalue;
47  Real _outvalue;
48  Real _int_width;
51 
52  unsigned int _num_dim;
53 
54  std::vector<Point> _centers;
55  std::vector<Real> _radii;
56 
57  enum class ProfileType
58  {
59  COS,
60  TANH
61  } _profile;
62 
63  MooseRandom _random;
64 };
65 
SmoothCircleBaseIC::computeCircleCenters
virtual void computeCircleCenters()=0
SmoothCircleBaseIC::_random
MooseRandom _random
Definition: SmoothCircleBaseIC.h:63
SmoothCircleBaseIC::_centers
std::vector< Point > _centers
Definition: SmoothCircleBaseIC.h:54
SmoothCircleBaseIC::ProfileType::COS
SmoothCircleBaseIC::value
virtual Real value(const Point &p)
Definition: SmoothCircleBaseIC.C:71
validParams< SmoothCircleBaseIC >
InputParameters validParams< SmoothCircleBaseIC >()
Definition: SmoothCircleBaseIC.C:18
SmoothCircleBaseIC::computeCircleValue
virtual Real computeCircleValue(const Point &p, const Point &center, const Real &radius)
Definition: SmoothCircleBaseIC.C:110
libMesh::RealGradient
VectorValue< Real > RealGradient
Definition: GrainForceAndTorqueInterface.h:17
SmoothCircleBaseIC::computeCircleRadii
virtual void computeCircleRadii()=0
SmoothCircleBaseIC
SmoothcircleBaseIC is the base class for all initial conditions that create circles.
Definition: SmoothCircleBaseIC.h:26
SmoothCircleBaseIC::_profile
enum SmoothCircleBaseIC::ProfileType _profile
SmoothCircleBaseIC::_num_dim
unsigned int _num_dim
Definition: SmoothCircleBaseIC.h:52
SmoothCircleBaseIC::_radii
std::vector< Real > _radii
Definition: SmoothCircleBaseIC.h:55
SmoothCircleBaseIC::ProfileType::TANH
SmoothCircleBaseIC::_invalue
Real _invalue
Definition: SmoothCircleBaseIC.h:46
SmoothCircleBaseIC::computeCircleGradient
virtual RealGradient computeCircleGradient(const Point &p, const Point &center, const Real &radius)
Definition: SmoothCircleBaseIC.C:149
SmoothCircleBaseIC::_mesh
MooseMesh & _mesh
Definition: SmoothCircleBaseIC.h:44
SmoothCircleBaseIC::_outvalue
Real _outvalue
Definition: SmoothCircleBaseIC.h:47
SmoothCircleBaseIC::_zero_gradient
bool _zero_gradient
Definition: SmoothCircleBaseIC.h:50
SmoothCircleBaseIC::_int_width
Real _int_width
Definition: SmoothCircleBaseIC.h:48
SmoothCircleBaseIC::gradient
virtual RealGradient gradient(const Point &p)
Definition: SmoothCircleBaseIC.C:87
SmoothCircleBaseIC::_3D_spheres
bool _3D_spheres
Definition: SmoothCircleBaseIC.h:49
SmoothCircleBaseIC::initialSetup
virtual void initialSetup()
Definition: SmoothCircleBaseIC.C:57
SmoothCircleBaseIC::SmoothCircleBaseIC
SmoothCircleBaseIC(const InputParameters &parameters)
Definition: SmoothCircleBaseIC.C:38
SmoothCircleBaseIC::ProfileType
ProfileType
Definition: SmoothCircleBaseIC.h:57