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

An InitialCondition for initializing phase variable in close packed circles/spheres pattern. More...

#include <ClosePackIC.h>

Inheritance diagram for ClosePackIC:
[legend]

Public Member Functions

 ClosePackIC (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 void computeCircleRadii ()
 The radius are populated in the computeCircleCenters. More...
 
virtual void computeCircleCenters ()
 Compute the close packed centers and radii. More...
 
virtual Real computeCircleValue (const Point &p, const Point &center, const Real &radius)
 
virtual RealGradient computeCircleGradient (const Point &p, const Point &center, const Real &radius)
 

Protected Attributes

const Real _radius
 User-supplied circle radius. More...
 
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

An InitialCondition for initializing phase variable in close packed circles/spheres pattern.

Definition at line 25 of file ClosePackIC.h.

Member Enumeration Documentation

◆ ProfileType

enum SmoothCircleBaseIC::ProfileType
strongprotectedinherited
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

◆ ClosePackIC()

ClosePackIC::ClosePackIC ( const InputParameters &  parameters)

Definition at line 28 of file ClosePackIC.C.

29  : SmoothCircleBaseIC(parameters), _radius(parameters.get<Real>("radius"))
30 {
31 }
const Real _radius
User-supplied circle radius.
Definition: ClosePackIC.h:38
SmoothCircleBaseIC(const InputParameters &parameters)

Member Function Documentation

◆ computeCircleCenters()

void ClosePackIC::computeCircleCenters ( )
protectedvirtual

Compute the close packed centers and radii.

Implements SmoothCircleBaseIC.

Definition at line 34 of file ClosePackIC.C.

35 {
36  // Determine the extents of the mesh
37  BoundingBox bbox = MeshTools::create_bounding_box(_fe_problem.mesh().getMesh());
38  const Point & min = bbox.min();
39  const Point & max = bbox.max();
40 
41  // Create the x,y,z limits for the while loops
42  Real x_min = min(0);
43  Real x_max = max(0) + 2.0 * _radius;
44 
45  Real y_min = min(1) - 2.0 * std::sqrt(3.0) * _radius + _radius;
46  Real y_max = max(1) + 2.0 * _radius;
47 
48  // Real z_min = min(2) - 2*std::sqrt(3.0)*_radius + _radius;
49  Real z_max = 0.0;
50 
51  // Initialize the coordinates that will be used in looping
52  Real x = x_min;
53  Real y = y_min;
54  Real z = 0.0;
55 
56  // Adjust the 3D z-dimension maximum
57  if (_fe_problem.mesh().dimension() == 3)
58  z_max = max(2) + 2.0 * _radius;
59 
60  // Counters for offsetting every other row column in x,y dimensions
61  unsigned int i = 0;
62  unsigned int j = 0;
63 
64  while (z <= z_max)
65  {
66  // Offset the y-coordinate by sqrt(3)*r every other loop
67  if (j % 2 != 0)
68  y += std::sqrt(3) * _radius / 2.0;
69 
70  while (y <= y_max)
71  {
72 
73  // Offset the x-coordinate by r every other loop
74  if (i % 2 == 0)
75  x += _radius;
76 
77  while (x <= x_max)
78  {
79  _centers.push_back(Point(x, y, z));
80  _radii.push_back(_radius);
81  x += 2.0 * _radius;
82  }
83 
84  // Reset x-coord and increment y-coord
85  x = x_min;
86  y += std::sqrt(3.0) * _radius;
87  i++;
88  }
89 
90  // Reset y-coord and increment z-coord
91  y = y_min;
92  z += std::sqrt(3.0) * _radius;
93  j++;
94  }
95 }
std::vector< Real > _radii
const Real _radius
User-supplied circle radius.
Definition: ClosePackIC.h:38
std::vector< Point > _centers

◆ computeCircleGradient()

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

Definition at line 150 of file SmoothCircleBaseIC.C.

Referenced by SmoothCircleBaseIC::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 ClosePackIC::computeCircleRadii ( )
inlineprotectedvirtual

The radius are populated in the computeCircleCenters.

Implements SmoothCircleBaseIC.

Definition at line 32 of file ClosePackIC.h.

32 {}

◆ computeCircleValue()

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

Reimplemented in RndSmoothCircleIC.

Definition at line 110 of file SmoothCircleBaseIC.C.

Referenced by SmoothCircleBaseIC::gradient(), and SmoothCircleBaseIC::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)
virtualinherited

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 ( )
virtualinherited

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)
virtualinherited

Reimplemented in PolycrystalVoronoiVoidIC.

Definition at line 71 of file SmoothCircleBaseIC.C.

Referenced by RndSmoothCircleIC::computeCircleValue(), SmoothCircleBaseIC::computeCircleValue(), SmoothCircleBaseIC::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
protectedinherited

◆ _centers

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

◆ _int_width

Real SmoothCircleBaseIC::_int_width
protectedinherited

◆ _invalue

Real SmoothCircleBaseIC::_invalue
protectedinherited

◆ _mesh

MooseMesh& SmoothCircleBaseIC::_mesh
protectedinherited

◆ _num_dim

unsigned int SmoothCircleBaseIC::_num_dim
protectedinherited

Definition at line 53 of file SmoothCircleBaseIC.h.

◆ _outvalue

Real SmoothCircleBaseIC::_outvalue
protectedinherited

◆ _profile

enum SmoothCircleBaseIC::ProfileType SmoothCircleBaseIC::_profile
protectedinherited

◆ _radii

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

◆ _radius

const Real ClosePackIC::_radius
protected

User-supplied circle radius.

Definition at line 38 of file ClosePackIC.h.

Referenced by computeCircleCenters().

◆ _random

MooseRandom SmoothCircleBaseIC::_random
protectedinherited

◆ _zero_gradient

bool SmoothCircleBaseIC::_zero_gradient
protectedinherited

Definition at line 51 of file SmoothCircleBaseIC.h.

Referenced by SmoothCircleBaseIC::gradient().


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