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

MultismoothCircleIC creates multiple SmoothCircles (number = numbub) that are randomly positioned around the domain with a minimum spacing equal to bubspac. More...

#include <MultiSmoothCircleIC.h>

Inheritance diagram for MultiSmoothCircleIC:
[legend]

Public Member Functions

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

Protected Types

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

Protected Member Functions

virtual void computeCircleRadii () override
 
virtual void computeCircleCenters () override
 
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 unsigned int _numbub
 
const Real _bubspac
 
const unsigned int _max_num_tries
 
const Real _radius
 
const Real _radius_variation
 
const MooseEnum _radius_variation_type
 
Point _bottom_left
 
Point _top_right
 
Point _range
 
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

MultismoothCircleIC creates multiple SmoothCircles (number = numbub) that are randomly positioned around the domain with a minimum spacing equal to bubspac.

The system attempts to randomly place bubbles in the domain until the desired number of distinct bubbles are placed. If the number of attempts exceeds "max_tries", a mooseError will be thrown and the program will terminate.

Definition at line 28 of file MultiSmoothCircleIC.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

◆ MultiSmoothCircleIC()

MultiSmoothCircleIC::MultiSmoothCircleIC ( const InputParameters &  parameters)

Definition at line 41 of file MultiSmoothCircleIC.C.

42  : SmoothCircleBaseIC(parameters),
43  _numbub(getParam<unsigned int>("numbub")),
44  _bubspac(getParam<Real>("bubspac")),
45  _max_num_tries(getParam<unsigned int>("numtries")),
46  _radius(getParam<Real>("radius")),
47  _radius_variation(getParam<Real>("radius_variation")),
48  _radius_variation_type(getParam<MooseEnum>("radius_variation_type"))
49 {
50 }
const MooseEnum _radius_variation_type
const unsigned int _max_num_tries
SmoothCircleBaseIC(const InputParameters &parameters)
const unsigned int _numbub

Member Function Documentation

◆ computeCircleCenters()

void MultiSmoothCircleIC::computeCircleCenters ( )
overrideprotectedvirtual

Implements SmoothCircleBaseIC.

Reimplemented in PolycrystalVoronoiVoidIC.

Definition at line 96 of file MultiSmoothCircleIC.C.

97 {
98  _centers.resize(_numbub);
99  for (unsigned int i = 0; i < _numbub; ++i)
100  {
101  // Vary circle center positions
102  unsigned int num_tries = 0;
103  while (num_tries < _max_num_tries)
104  {
105  num_tries++;
106 
107  RealTensorValue ran;
108  ran(0, 0) = _random.rand(_tid);
109  ran(1, 1) = _random.rand(_tid);
110  ran(2, 2) = _random.rand(_tid);
111 
112  _centers[i] = _bottom_left + ran * _range;
113 
114  for (unsigned int j = 0; j < i; ++j)
115  if (_mesh.minPeriodicDistance(_var.number(), _centers[j], _centers[i]) < _bubspac)
116  goto fail;
117 
118  // accept the position of the new center
119  goto accept;
120 
121  // retry a new position until tries are exhausted
122  fail:
123  continue;
124  }
125 
126  if (num_tries == _max_num_tries)
127  mooseError("Too many tries in MultiSmoothCircleIC");
128 
129  accept:
130  continue;
131  }
132 }
std::vector< Point > _centers
const unsigned int _max_num_tries
const unsigned int _numbub

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

void MultiSmoothCircleIC::computeCircleRadii ( )
overrideprotectedvirtual

Implements SmoothCircleBaseIC.

Definition at line 72 of file MultiSmoothCircleIC.C.

73 {
74  _radii.resize(_numbub);
75 
76  for (unsigned int i = 0; i < _numbub; i++)
77  {
78  // Vary bubble radius
79  switch (_radius_variation_type)
80  {
81  case 0: // Uniform distribution
82  _radii[i] = _radius * (1.0 + (1.0 - 2.0 * _random.rand(_tid)) * _radius_variation);
83  break;
84  case 1: // Normal distribution
85  _radii[i] = _random.randNormal(_tid, _radius, _radius_variation);
86  break;
87  case 2: // No variation
88  _radii[i] = _radius;
89  }
90 
91  _radii[i] = std::max(_radii[i], 0.0);
92  }
93 }
std::vector< Real > _radii
const MooseEnum _radius_variation_type
const unsigned int _numbub

◆ 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 MultiSmoothCircleIC::initialSetup ( )
overridevirtual

Reimplemented from SmoothCircleBaseIC.

Reimplemented in PolycrystalVoronoiVoidIC.

Definition at line 53 of file MultiSmoothCircleIC.C.

Referenced by PolycrystalVoronoiVoidIC::initialSetup().

54 {
55  // Set up domain bounds with mesh tools
56  for (unsigned int i = 0; i < LIBMESH_DIM; ++i)
57  {
58  _bottom_left(i) = _mesh.getMinInDimension(i);
59  _top_right(i) = _mesh.getMaxInDimension(i);
60  }
62 
63  // a variation is provided, but the type is set to 'none'
64  if (_radius_variation > 0.0 && _radius_variation_type == 2)
65  mooseError("If radius_variation > 0.0, you must pass in a radius_variation_type in "
66  "MultiSmoothCircleIC");
67 
69 }
const MooseEnum _radius_variation_type
virtual void initialSetup()

◆ 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

◆ _bottom_left

Point MultiSmoothCircleIC::_bottom_left
protected

◆ _bubspac

const Real MultiSmoothCircleIC::_bubspac
protected

◆ _centers

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

◆ _int_width

Real SmoothCircleBaseIC::_int_width
protectedinherited

◆ _invalue

Real SmoothCircleBaseIC::_invalue
protectedinherited

◆ _max_num_tries

const unsigned int MultiSmoothCircleIC::_max_num_tries
protected

◆ _mesh

MooseMesh& SmoothCircleBaseIC::_mesh
protectedinherited

◆ _num_dim

unsigned int SmoothCircleBaseIC::_num_dim
protectedinherited

Definition at line 53 of file SmoothCircleBaseIC.h.

◆ _numbub

const unsigned int MultiSmoothCircleIC::_numbub
protected

◆ _outvalue

Real SmoothCircleBaseIC::_outvalue
protectedinherited

◆ _profile

enum SmoothCircleBaseIC::ProfileType SmoothCircleBaseIC::_profile
protectedinherited

◆ _radii

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

◆ _radius

const Real MultiSmoothCircleIC::_radius
protected

◆ _radius_variation

const Real MultiSmoothCircleIC::_radius_variation
protected

Definition at line 45 of file MultiSmoothCircleIC.h.

Referenced by computeCircleRadii(), and initialSetup().

◆ _radius_variation_type

const MooseEnum MultiSmoothCircleIC::_radius_variation_type
protected

Definition at line 46 of file MultiSmoothCircleIC.h.

Referenced by computeCircleRadii(), and initialSetup().

◆ _random

MooseRandom SmoothCircleBaseIC::_random
protectedinherited

◆ _range

Point MultiSmoothCircleIC::_range
protected

◆ _top_right

Point MultiSmoothCircleIC::_top_right
protected

◆ _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: