LatticeSmoothcircleIC creates a lattice of smoothcircles as an initial condition. More...

#include <LatticeSmoothCircleIC.h>

Inheritance diagram for LatticeSmoothCircleIC:

Public Member Functions
	LatticeSmoothCircleIC (const InputParameters &parameters)

virtual void	initialSetup ()

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

virtual void	computeCircleCenters ()

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
Real	_lattice_variation

std::vector< unsigned int >	_circles_per_side

unsigned int	_numbub

Real	_radius

Real	_radius_variation

MooseEnum	_radius_variation_type

bool	_avoid_bounds

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

LatticeSmoothcircleIC creates a lattice of smoothcircles as an initial condition.

They are either directly on the lattice or randomly perturbed from the lattice.

Definition at line 24 of file LatticeSmoothCircleIC.h.

Member Enumeration Documentation

◆ ProfileType

enum SmoothCircleBaseIC::ProfileType

strongprotectedinherited

Enumerator
COS
TANH

Definition at line 57 of file SmoothCircleBaseIC.h.

   {
     COS,
     TANH
   } _profile;

Constructor & Destructor Documentation

◆ LatticeSmoothCircleIC()

LatticeSmoothCircleIC::LatticeSmoothCircleIC ( const InputParameters & parameters )

Definition at line 40 of file LatticeSmoothCircleIC.C.

   : SmoothCircleBaseIC(parameters),
     _lattice_variation(isParamValid("Rnd_variation") ? getParam<Real>("Rnd_variation")
                                                      : getParam<Real>("pos_variation")),
     _circles_per_side(getParam<std::vector<unsigned int>>("circles_per_side")),
     _radius(getParam<Real>("radius")),
     _radius_variation(getParam<Real>("radius_variation")),
     _radius_variation_type(getParam<MooseEnum>("radius_variation_type")),
     _avoid_bounds(getParam<bool>("avoid_bounds"))
 {
 }

Member Function Documentation

◆ computeCircleCenters()

void LatticeSmoothCircleIC::computeCircleCenters ( )

protectedvirtual

Implements SmoothCircleBaseIC.

Definition at line 125 of file LatticeSmoothCircleIC.C.

 {
   _centers.resize(_numbub);
  
   Real x_sep = _range(0) / _circles_per_side[0];
   Real y_sep = _range(1) / _circles_per_side[1];
  
   Real z_sep = 0.0;
   unsigned int z_num = 1.0;
  
   if (_range(2) > 0.0)
   {
     z_sep = _range(2) / _circles_per_side[2];
     z_num = _circles_per_side[2];
   }
  
   unsigned int cnt = 0;
   for (unsigned int i = 0; i < _circles_per_side[0]; ++i)
     for (unsigned int j = 0; j < _circles_per_side[1]; ++j)
       for (unsigned int k = 0; k < z_num; ++k)
       {
         Real xx = x_sep / 2.0 + i * x_sep;
         Real yy = y_sep / 2.0 + j * y_sep;
         Real zz = z_sep / 2.0 + k * z_sep;
  
         // Vary circle position
         xx = xx + (1.0 - 2.0 * _random.rand(_tid)) * _lattice_variation;
         yy = yy + (1.0 - 2.0 * _random.rand(_tid)) * _lattice_variation;
  
         if (_range(2) != 0.0)
           zz = zz + (1.0 - 2.0 * _random.rand(_tid)) * _lattice_variation;
  
         // Verify not out of bounds
         if (_avoid_bounds && xx < _radii[cnt] + _int_width)
           xx = _radii[cnt] + _int_width;
         if (_avoid_bounds && xx > _range(0) - (_radii[cnt] + _int_width))
           xx = _range(0) - (_radii[cnt] + _int_width);
         if (_avoid_bounds && yy < _radii[cnt] + _int_width)
           yy = _radii[cnt] + _int_width;
         if (_avoid_bounds && yy > _range(1) - (_radii[cnt] + _int_width))
           yy = _range(1) - (_radii[cnt] + _int_width);
         if (_range(2) != 0.0)
         {
           if (_avoid_bounds && zz < _radii[cnt] + _int_width)
             zz = _radii[cnt] + _int_width;
           if (_avoid_bounds && zz > _range(2) - (_radii[cnt] + _int_width))
             zz = _range(2) - (_radii[cnt] + _int_width);
         }
  
         _centers[cnt](0) = xx;
         _centers[cnt](1) = yy;
         _centers[cnt](2) = zz;
  
         cnt++;
       }
 }

◆ computeCircleGradient()

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

protectedvirtualinherited

Definition at line 149 of file SmoothCircleBaseIC.C.

 {
   Point l_center = center;
   Point l_p = p;
   if (!_3D_spheres) // Create 3D cylinders instead of spheres
   {
     l_p(2) = 0.0;
     l_center(2) = 0.0;
   }
   // Compute the distance between the current point and the center
   Real dist = _mesh.minPeriodicDistance(_var.number(), l_p, l_center);
  
   // early return if we are probing the center of the circle
   if (dist == 0.0)
     return 0.0;
  
   Real DvalueDr = 0.0;
   switch (_profile)
   {
     case ProfileType::COS:
       if (dist < radius + _int_width / 2.0 && dist > radius - _int_width / 2.0)
       {
         const Real int_pos = (dist - radius + _int_width / 2.0) / _int_width;
         const Real Dint_posDr = 1.0 / _int_width;
         DvalueDr = Dint_posDr * (_invalue - _outvalue) *
                    (-std::sin(int_pos * libMesh::pi) * libMesh::pi) / 2.0;
       }
       break;
  
     case ProfileType::TANH:
       DvalueDr = -(_invalue - _outvalue) * 0.5 / _int_width * libMesh::pi *
                  (1.0 - Utility::pow<2>(std::tanh(4.0 * (radius - dist) / _int_width)));
       break;
  
     default:
       mooseError("Internal error.");
   }
  
   return _mesh.minPeriodicVector(_var.number(), center, p) * (DvalueDr / dist);
 }

Referenced by SmoothCircleBaseIC::gradient().

◆ computeCircleRadii()

void LatticeSmoothCircleIC::computeCircleRadii ( )

protectedvirtual

Implements SmoothCircleBaseIC.

Definition at line 100 of file LatticeSmoothCircleIC.C.

 {
   _radii.resize(_numbub);
  
   for (unsigned int i = 0; i < _numbub; i++)
   {
     // Vary bubble radius
     switch (_radius_variation_type)
     {
       case 0: // Uniform distrubtion
         _radii[i] = _radius * (1.0 + (1.0 - 2.0 * _random.rand(_tid)) * _radius_variation);
         break;
       case 1: // Normal distribution
         _radii[i] = _random.randNormal(_tid, _radius, _radius_variation);
         break;
       case 2: // No variation
         _radii[i] = _radius;
     }
  
     if (_radii[i] < 0.0)
       _radii[i] = 0.0;
   }
 }

◆ 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.

 {
   Point l_center = center;
   Point l_p = p;
   if (!_3D_spheres) // Create 3D cylinders instead of spheres
   {
     l_p(2) = 0.0;
     l_center(2) = 0.0;
   }
   // Compute the distance between the current point and the center
   Real dist = _mesh.minPeriodicDistance(_var.number(), l_p, l_center);
  
   switch (_profile)
   {
     case ProfileType::COS:
     {
       // Return value
       Real value = _outvalue; // Outside circle
  
       if (dist <= radius - _int_width / 2.0) // Inside circle
         value = _invalue;
       else if (dist < radius + _int_width / 2.0) // Smooth interface
       {
         Real int_pos = (dist - radius + _int_width / 2.0) / _int_width;
         value = _outvalue + (_invalue - _outvalue) * (1.0 + std::cos(int_pos * libMesh::pi)) / 2.0;
       }
       return value;
     }
  
     case ProfileType::TANH:
       return (_invalue - _outvalue) * 0.5 * (std::tanh(2.0 * (radius - dist) / _int_width) + 1.0) +
              _outvalue;
  
     default:
       mooseError("Internal error.");
   }
 }

Referenced by SmoothCircleBaseIC::gradient(), and SmoothCircleBaseIC::value().

◆ gradient()

RealGradient SmoothCircleBaseIC::gradient ( const Point & p )

virtualinherited

Reimplemented in PolycrystalVoronoiVoidIC.

Definition at line 87 of file SmoothCircleBaseIC.C.

 {
   if (_zero_gradient)
     return 0.0;
  
   RealGradient gradient = 0.0;
   Real value = _outvalue;
   Real val2 = 0.0;
  
   for (unsigned int circ = 0; circ < _centers.size(); ++circ)
   {
     val2 = computeCircleValue(p, _centers[circ], _radii[circ]);
     if ((val2 > value && _invalue > _outvalue) || (val2 < value && _outvalue > _invalue))
     {
       value = val2;
       gradient = computeCircleGradient(p, _centers[circ], _radii[circ]);
     }
   }
  
   return gradient;
 }

Referenced by PolycrystalVoronoiVoidIC::gradient().

◆ initialSetup()

void LatticeSmoothCircleIC::initialSetup ( )

virtual

Reimplemented from SmoothCircleBaseIC.

Definition at line 53 of file LatticeSmoothCircleIC.C.

 {
   // pad circles per side vector to size 3 (with 0)
   _circles_per_side.resize(3);
  
   // Set up domain bounds with mesh tools
   for (unsigned int i = 0; i < LIBMESH_DIM; ++i)
   {
     _bottom_left(i) = _mesh.getMinInDimension(i);
     _top_right(i) = _mesh.getMaxInDimension(i);
   }
   _range = _top_right - _bottom_left;
  
   // Error checks
   if (_range(0) != 0.0 && _range(1) != 0.0 && _circles_per_side[1] == 0)
     mooseError("If domain is > 1D, circles_per_side must have more than one value");
  
   if (_range(2) != 0.0 && _circles_per_side[2] == 0)
     mooseError("If domain is 3D, circles_per_side must have three values");
  
   if (_range(1) == 0.0 && _range(2) == 0.0)
   {
     _circles_per_side[1] = 0;
     _circles_per_side[2] = 0;
   }
  
   // Set _numbub
   if (_range(2) == 0.0)
   {
     _circles_per_side[2] = 0;
     _numbub = _circles_per_side[0] * _circles_per_side[1];
   }
   else
     _numbub = _circles_per_side[0] * _circles_per_side[1] * _circles_per_side[2];
  
   switch (_radius_variation_type)
   {
     case 2: // No variation
       if (_radius_variation > 0.0)
         mooseError("If radius_variation > 0.0, you must pass in a radius_variation_type in "
                    "LatticeSmoothCircleIC");
       break;
   }
   SmoothCircleBaseIC::initialSetup();
 }

◆ value()

Real SmoothCircleBaseIC::value ( const Point & p )

virtualinherited

Reimplemented in PolycrystalVoronoiVoidIC.

Definition at line 71 of file SmoothCircleBaseIC.C.

 {
   Real value = _outvalue;
   Real val2 = 0.0;
  
   for (unsigned int circ = 0; circ < _centers.size() && value != _invalue; ++circ)
   {
     val2 = computeCircleValue(p, _centers[circ], _radii[circ]);
     if ((val2 > value && _invalue > _outvalue) || (val2 < value && _outvalue > _invalue))
       value = val2;
   }
  
   return value;
 }

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

Member Data Documentation

◆ _3D_spheres

bool SmoothCircleBaseIC::_3D_spheres

protectedinherited

Definition at line 49 of file SmoothCircleBaseIC.h.

Referenced by SmoothCircleBaseIC::computeCircleGradient(), RndSmoothCircleIC::computeCircleValue(), and SmoothCircleBaseIC::computeCircleValue().

◆ _avoid_bounds

bool LatticeSmoothCircleIC::_avoid_bounds

protected

Definition at line 43 of file LatticeSmoothCircleIC.h.

Referenced by computeCircleCenters().

◆ _bottom_left

Point LatticeSmoothCircleIC::_bottom_left

protected

Definition at line 45 of file LatticeSmoothCircleIC.h.

Referenced by initialSetup().

◆ _centers

std::vector<Point> SmoothCircleBaseIC::_centers

protectedinherited

Definition at line 54 of file SmoothCircleBaseIC.h.

Referenced by SmoothCircleIC::computeCircleCenters(), computeCircleCenters(), SpecifiedSmoothCircleIC::computeCircleCenters(), ClosePackIC::computeCircleCenters(), SmoothCircleFromFileIC::computeCircleCenters(), MultiSmoothCircleIC::computeCircleCenters(), PolycrystalVoronoiVoidIC::computeCircleCenters(), SmoothCircleBaseIC::gradient(), SmoothCircleBaseIC::initialSetup(), and SmoothCircleBaseIC::value().

◆ _circles_per_side

std::vector<unsigned int> LatticeSmoothCircleIC::_circles_per_side

protected

Definition at line 36 of file LatticeSmoothCircleIC.h.

Referenced by computeCircleCenters(), and initialSetup().

◆ _int_width

Real SmoothCircleBaseIC::_int_width

protectedinherited

Definition at line 48 of file SmoothCircleBaseIC.h.

Referenced by computeCircleCenters(), SmoothCircleBaseIC::computeCircleGradient(), RndSmoothCircleIC::computeCircleValue(), SmoothCircleBaseIC::computeCircleValue(), and SmoothCircleBaseIC::SmoothCircleBaseIC().

◆ _invalue

Real SmoothCircleBaseIC::_invalue

protectedinherited

Definition at line 46 of file SmoothCircleBaseIC.h.

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

◆ _lattice_variation

Real LatticeSmoothCircleIC::_lattice_variation

protected

Definition at line 35 of file LatticeSmoothCircleIC.h.

Referenced by computeCircleCenters().

◆ _mesh

MooseMesh& SmoothCircleBaseIC::_mesh

protectedinherited

Definition at line 44 of file SmoothCircleBaseIC.h.

Referenced by MultiSmoothCircleIC::computeCircleCenters(), PolycrystalVoronoiVoidIC::computeCircleCenters(), SmoothCircleBaseIC::computeCircleGradient(), RndSmoothCircleIC::computeCircleValue(), SmoothCircleBaseIC::computeCircleValue(), initialSetup(), and MultiSmoothCircleIC::initialSetup().

◆ _num_dim

unsigned int SmoothCircleBaseIC::_num_dim

protectedinherited

Definition at line 52 of file SmoothCircleBaseIC.h.

◆ _numbub

unsigned int LatticeSmoothCircleIC::_numbub

protected

Definition at line 37 of file LatticeSmoothCircleIC.h.

Referenced by computeCircleCenters(), computeCircleRadii(), and initialSetup().

◆ _outvalue

Real SmoothCircleBaseIC::_outvalue

protectedinherited

Definition at line 47 of file SmoothCircleBaseIC.h.

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

◆ _profile

enum SmoothCircleBaseIC::ProfileType SmoothCircleBaseIC::_profile

protectedinherited

Referenced by SmoothCircleBaseIC::computeCircleGradient(), SmoothCircleBaseIC::computeCircleValue(), RndSmoothCircleIC::RndSmoothCircleIC(), and SmoothCircleBaseIC::SmoothCircleBaseIC().

◆ _radii

std::vector<Real> SmoothCircleBaseIC::_radii

protectedinherited

Definition at line 55 of file SmoothCircleBaseIC.h.

Referenced by computeCircleCenters(), ClosePackIC::computeCircleCenters(), SmoothCircleIC::computeCircleRadii(), computeCircleRadii(), SpecifiedSmoothCircleIC::computeCircleRadii(), SmoothCircleFromFileIC::computeCircleRadii(), MultiSmoothCircleIC::computeCircleRadii(), SmoothCircleBaseIC::gradient(), SmoothCircleBaseIC::initialSetup(), and SmoothCircleBaseIC::value().

◆ _radius

Real LatticeSmoothCircleIC::_radius

protected

Definition at line 39 of file LatticeSmoothCircleIC.h.

Referenced by computeCircleRadii().

◆ _radius_variation

Real LatticeSmoothCircleIC::_radius_variation

protected

Definition at line 40 of file LatticeSmoothCircleIC.h.

Referenced by computeCircleRadii(), and initialSetup().

◆ _radius_variation_type

MooseEnum LatticeSmoothCircleIC::_radius_variation_type

protected

Definition at line 41 of file LatticeSmoothCircleIC.h.

Referenced by computeCircleRadii(), and initialSetup().

◆ _random

MooseRandom SmoothCircleBaseIC::_random

protectedinherited

Definition at line 63 of file SmoothCircleBaseIC.h.

Referenced by computeCircleCenters(), MultiSmoothCircleIC::computeCircleCenters(), PolycrystalVoronoiVoidIC::computeCircleCenters(), computeCircleRadii(), MultiSmoothCircleIC::computeCircleRadii(), RndSmoothCircleIC::computeCircleValue(), and SmoothCircleBaseIC::SmoothCircleBaseIC().

◆ _range

Point LatticeSmoothCircleIC::_range

protected

Definition at line 47 of file LatticeSmoothCircleIC.h.

Referenced by computeCircleCenters(), and initialSetup().

◆ _top_right

Point LatticeSmoothCircleIC::_top_right

protected

Definition at line 46 of file LatticeSmoothCircleIC.h.

Referenced by initialSetup().

◆ _zero_gradient

bool SmoothCircleBaseIC::_zero_gradient

protectedinherited

Definition at line 50 of file SmoothCircleBaseIC.h.

Referenced by SmoothCircleBaseIC::gradient().

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

phase_field/include/ics/LatticeSmoothCircleIC.h
phase_field/src/ics/LatticeSmoothCircleIC.C

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ProfileType

Constructor & Destructor Documentation

◆ LatticeSmoothCircleIC()

Member Function Documentation

◆ computeCircleCenters()

◆ computeCircleGradient()

◆ computeCircleRadii()

◆ computeCircleValue()

◆ gradient()

◆ initialSetup()

◆ value()

Member Data Documentation

◆ _3D_spheres

◆ _avoid_bounds

◆ _bottom_left

◆ _centers

◆ _circles_per_side

◆ _int_width

◆ _invalue

◆ _lattice_variation

◆ _mesh

◆ _num_dim

◆ _numbub

◆ _outvalue

◆ _profile

◆ _radii

◆ _radius

◆ _radius_variation

◆ _radius_variation_type

◆ _random

◆ _range

◆ _top_right

◆ _zero_gradient