www.mooseframework.org
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
SmoothCircleBaseIC Class Referenceabstract

SmoothcircleBaseIC is the base class for all initial conditions that create circles. More...

#include <SmoothCircleBaseIC.h>

Inheritance diagram for SmoothCircleBaseIC:
[legend]

Public Member Functions

 SmoothCircleBaseIC (const InputParameters &parameters)
 
virtual Real value (const Point &p)
 
virtual RealGradient gradient (const Point &p)
 
virtual void initialSetup ()
 

Protected Types

enum  ProfileType { ProfileType::COS, ProfileType::TANH }
 

Protected Member Functions

virtual Real computeCircleValue (const Point &p, const Point &center, const Real &radius)
 
virtual RealGradient computeCircleGradient (const Point &p, const Point &center, const Real &radius)
 
virtual void computeCircleRadii ()=0
 
virtual void computeCircleCenters ()=0
 

Protected Attributes

MooseMesh & _mesh
 
Real _invalue
 
Real _outvalue
 
Real _int_width
 
bool _3D_spheres
 
bool _zero_gradient
 
unsigned int _num_dim
 
std::vector< Point > _centers
 
std::vector< Real > _radii
 
enum SmoothCircleBaseIC::ProfileType _profile
 
MooseRandom _random
 

Detailed Description

SmoothcircleBaseIC is the base class for all initial conditions that create circles.

The circles can have sharp interfaces or a finite interface width. Note that all children must resize _radii and _centers.

Definition at line 27 of file SmoothCircleBaseIC.h.

Member Enumeration Documentation

◆ ProfileType

enum SmoothCircleBaseIC::ProfileType
strongprotected
Enumerator
COS 
TANH 

Definition at line 58 of file SmoothCircleBaseIC.h.

59  {
60  COS,
61  TANH
62  } _profile;
enum SmoothCircleBaseIC::ProfileType _profile

Constructor & Destructor Documentation

◆ SmoothCircleBaseIC()

SmoothCircleBaseIC::SmoothCircleBaseIC ( const InputParameters &  parameters)

Definition at line 38 of file SmoothCircleBaseIC.C.

39  : InitialCondition(parameters),
40  _mesh(_fe_problem.mesh()),
41  _invalue(parameters.get<Real>("invalue")),
42  _outvalue(parameters.get<Real>("outvalue")),
43  _int_width(parameters.get<Real>("int_width")),
44  _3D_spheres(parameters.get<bool>("3D_spheres")),
45  _zero_gradient(parameters.get<bool>("zero_gradient")),
46  _num_dim(_3D_spheres ? 3 : 2),
47  _profile(getParam<MooseEnum>("profile").getEnum<ProfileType>())
48 {
49  _random.seed(_tid, getParam<unsigned int>("rand_seed"));
50 
51  if (_int_width <= 0.0 && _profile == ProfileType::TANH)
52  paramError("int_width",
53  "Interface width has to be strictly positive for the hyperbolic tangent profile");
54 }
enum SmoothCircleBaseIC::ProfileType _profile

Member Function Documentation

◆ computeCircleCenters()

virtual void SmoothCircleBaseIC::computeCircleCenters ( )
protectedpure virtual

◆ computeCircleGradient()

RealGradient SmoothCircleBaseIC::computeCircleGradient ( const Point &  p,
const Point &  center,
const Real &  radius 
)
protectedvirtual

Definition at line 150 of file SmoothCircleBaseIC.C.

Referenced by gradient().

153 {
154  Point l_center = center;
155  Point l_p = p;
156  if (!_3D_spheres) // Create 3D cylinders instead of spheres
157  {
158  l_p(2) = 0.0;
159  l_center(2) = 0.0;
160  }
161  // Compute the distance between the current point and the center
162  Real dist = _mesh.minPeriodicDistance(_var.number(), l_p, l_center);
163 
164  // early return if we are probing the center of the circle
165  if (dist == 0.0)
166  return 0.0;
167 
168  Real DvalueDr = 0.0;
169  switch (_profile)
170  {
171  case ProfileType::COS:
172  if (dist < radius + _int_width / 2.0 && dist > radius - _int_width / 2.0)
173  {
174  const Real int_pos = (dist - radius + _int_width / 2.0) / _int_width;
175  const Real Dint_posDr = 1.0 / _int_width;
176  DvalueDr = Dint_posDr * (_invalue - _outvalue) *
177  (-std::sin(int_pos * libMesh::pi) * libMesh::pi) / 2.0;
178  }
179  break;
180 
181  case ProfileType::TANH:
182  DvalueDr = -(_invalue - _outvalue) * 0.5 / _int_width * libMesh::pi *
183  (1.0 - Utility::pow<2>(std::tanh(4.0 * (radius - dist) / _int_width)));
184  break;
185 
186  default:
187  mooseError("Internal error.");
188  }
189 
190  return _mesh.minPeriodicVector(_var.number(), center, p) * (DvalueDr / dist);
191 }
enum SmoothCircleBaseIC::ProfileType _profile

◆ computeCircleRadii()

virtual void SmoothCircleBaseIC::computeCircleRadii ( )
protectedpure virtual

◆ computeCircleValue()

Real SmoothCircleBaseIC::computeCircleValue ( const Point &  p,
const Point &  center,
const Real &  radius 
)
protectedvirtual

Reimplemented in RndSmoothCircleIC.

Definition at line 110 of file SmoothCircleBaseIC.C.

Referenced by gradient(), and value().

111 {
112  Point l_center = center;
113  Point l_p = p;
114  if (!_3D_spheres) // Create 3D cylinders instead of spheres
115  {
116  l_p(2) = 0.0;
117  l_center(2) = 0.0;
118  }
119  // Compute the distance between the current point and the center
120  Real dist = _mesh.minPeriodicDistance(_var.number(), l_p, l_center);
121 
122  switch (_profile)
123  {
124  case ProfileType::COS:
125  {
126  // Return value
127  Real value = _outvalue; // Outside circle
128 
129  if (dist <= radius - _int_width / 2.0) // Inside circle
130  value = _invalue;
131  else if (dist < radius + _int_width / 2.0) // Smooth interface
132  {
133  Real int_pos = (dist - radius + _int_width / 2.0) / _int_width;
134  value = _outvalue + (_invalue - _outvalue) * (1.0 + std::cos(int_pos * libMesh::pi)) / 2.0;
135  }
136  return value;
137  }
138 
139  case ProfileType::TANH:
140  return (_invalue - _outvalue) * 0.5 *
141  (std::tanh(libMesh::pi * (radius - dist) / _int_width) + 1.0) +
142  _outvalue;
143 
144  default:
145  mooseError("Internal error.");
146  }
147 }
virtual Real value(const Point &p)
enum SmoothCircleBaseIC::ProfileType _profile

◆ gradient()

RealGradient SmoothCircleBaseIC::gradient ( const Point &  p)
virtual

Reimplemented in PolycrystalVoronoiVoidIC.

Definition at line 87 of file SmoothCircleBaseIC.C.

Referenced by PolycrystalVoronoiVoidIC::gradient().

88 {
89  if (_zero_gradient)
90  return 0.0;
91 
92  RealGradient gradient = 0.0;
93  Real value = _outvalue;
94  Real val2 = 0.0;
95 
96  for (unsigned int circ = 0; circ < _centers.size(); ++circ)
97  {
98  val2 = computeCircleValue(p, _centers[circ], _radii[circ]);
99  if ((val2 > value && _invalue > _outvalue) || (val2 < value && _outvalue > _invalue))
100  {
101  value = val2;
102  gradient = computeCircleGradient(p, _centers[circ], _radii[circ]);
103  }
104  }
105 
106  return gradient;
107 }
virtual Real computeCircleValue(const Point &p, const Point &center, const Real &radius)
std::vector< Real > _radii
std::vector< Point > _centers
virtual Real value(const Point &p)
virtual RealGradient computeCircleGradient(const Point &p, const Point &center, const Real &radius)
virtual RealGradient gradient(const Point &p)

◆ initialSetup()

void SmoothCircleBaseIC::initialSetup ( )
virtual

Reimplemented in MultiSmoothCircleIC, PolycrystalVoronoiVoidIC, and LatticeSmoothCircleIC.

Definition at line 57 of file SmoothCircleBaseIC.C.

Referenced by LatticeSmoothCircleIC::initialSetup(), and MultiSmoothCircleIC::initialSetup().

58 {
59  // Compute radii and centers and initialize vector sizes
62 
63  if (_centers.size() != _radii.size())
64  mooseError("_center and _radii vectors are not the same size in the Circle IC");
65 
66  if (_centers.size() < 1)
67  mooseError("_center and _radii were not initialized in the Circle IC");
68 }
std::vector< Real > _radii
std::vector< Point > _centers
virtual void computeCircleRadii()=0
virtual void computeCircleCenters()=0

◆ value()

Real SmoothCircleBaseIC::value ( const Point &  p)
virtual

Reimplemented in PolycrystalVoronoiVoidIC.

Definition at line 71 of file SmoothCircleBaseIC.C.

Referenced by RndSmoothCircleIC::computeCircleValue(), computeCircleValue(), gradient(), and PolycrystalVoronoiVoidIC::value().

72 {
73  Real value = _outvalue;
74  Real val2 = 0.0;
75 
76  for (unsigned int circ = 0; circ < _centers.size() && value != _invalue; ++circ)
77  {
78  val2 = computeCircleValue(p, _centers[circ], _radii[circ]);
79  if ((val2 > value && _invalue > _outvalue) || (val2 < value && _outvalue > _invalue))
80  value = val2;
81  }
82 
83  return value;
84 }
virtual Real computeCircleValue(const Point &p, const Point &center, const Real &radius)
std::vector< Real > _radii
std::vector< Point > _centers
virtual Real value(const Point &p)

Member Data Documentation

◆ _3D_spheres

bool SmoothCircleBaseIC::_3D_spheres
protected

◆ _centers

std::vector<Point> SmoothCircleBaseIC::_centers
protected

◆ _int_width

Real SmoothCircleBaseIC::_int_width
protected

◆ _invalue

Real SmoothCircleBaseIC::_invalue
protected

◆ _mesh

MooseMesh& SmoothCircleBaseIC::_mesh
protected

◆ _num_dim

unsigned int SmoothCircleBaseIC::_num_dim
protected

Definition at line 53 of file SmoothCircleBaseIC.h.

◆ _outvalue

Real SmoothCircleBaseIC::_outvalue
protected

◆ _profile

enum SmoothCircleBaseIC::ProfileType SmoothCircleBaseIC::_profile
protected

◆ _radii

std::vector<Real> SmoothCircleBaseIC::_radii
protected

◆ _random

MooseRandom SmoothCircleBaseIC::_random
protected

◆ _zero_gradient

bool SmoothCircleBaseIC::_zero_gradient
protected

Definition at line 51 of file SmoothCircleBaseIC.h.

Referenced by gradient().


The documentation for this class was generated from the following files: