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

#include <ClosePackIC.h>

Inheritance diagram for ClosePackIC:

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 24 of file ClosePackIC.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

◆ ClosePackIC()

ClosePackIC::ClosePackIC ( const InputParameters & parameters )

Definition at line 28 of file ClosePackIC.C.

   : SmoothCircleBaseIC(parameters), _radius(parameters.get<Real>("radius"))
 {
 }

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.

 {
   // Determine the extents of the mesh
   BoundingBox bbox = MeshTools::create_bounding_box(_fe_problem.mesh().getMesh());
   const Point & min = bbox.min();
   const Point & max = bbox.max();
  
   // Create the x,y,z limits for the while loops
   Real x_min = min(0);
   Real x_max = max(0) + 2.0 * _radius;
  
   Real y_min = min(1) - 2.0 * std::sqrt(3.0) * _radius + _radius;
   Real y_max = max(1) + 2.0 * _radius;
  
   // Real z_min = min(2) - 2*std::sqrt(3.0)*_radius + _radius;
   Real z_max = 0.0;
  
   // Initialize the coordinates that will be used in looping
   Real x = x_min;
   Real y = y_min;
   Real z = 0.0;
  
   // Adjust the 3D z-dimension maximum
   if (_fe_problem.mesh().dimension() == 3)
     z_max = max(2) + 2.0 * _radius;
  
   // Counters for offsetting every other row column in x,y dimensions
   unsigned int i = 0;
   unsigned int j = 0;
  
   while (z <= z_max)
   {
     // Offset the y-coordinate by sqrt(3)*r every other loop
     if (j % 2 != 0)
       y += std::sqrt(3) * _radius / 2.0;
  
     while (y <= y_max)
     {
  
       // Offset the x-coordinate by r every other loop
       if (i % 2 == 0)
         x += _radius;
  
       while (x <= x_max)
       {
         _centers.push_back(Point(x, y, z));
         _radii.push_back(_radius);
         x += 2.0 * _radius;
       }
  
       // Reset x-coord and increment y-coord
       x = x_min;
       y += std::sqrt(3.0) * _radius;
       i++;
     }
  
     // Reset y-coord and increment z-coord
     y = y_min;
     z += std::sqrt(3.0) * _radius;
     j++;
   }
 }

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

virtual void ClosePackIC::computeCircleRadii ( )

inlineprotectedvirtual

The radius are populated in the computeCircleCenters.

Implements SmoothCircleBaseIC.

Definition at line 31 of file ClosePackIC.h.

31 {}

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

virtualinherited

Reimplemented in PolycrystalVoronoiVoidIC, MultiSmoothCircleIC, and LatticeSmoothCircleIC.

Definition at line 57 of file SmoothCircleBaseIC.C.

 {
   // Compute radii and centers and initialize vector sizes
   computeCircleRadii();
   computeCircleCenters();
  
   if (_centers.size() != _radii.size())
     mooseError("_center and _radii vectors are not the same size in the Circle IC");
  
   if (_centers.size() < 1)
     mooseError("_center and _radii were not initialized in the Circle IC");
 }

Referenced by LatticeSmoothCircleIC::initialSetup(), and MultiSmoothCircleIC::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().

◆ _centers

std::vector<Point> SmoothCircleBaseIC::_centers

protectedinherited

Definition at line 54 of file SmoothCircleBaseIC.h.

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

◆ _int_width

Real SmoothCircleBaseIC::_int_width

protectedinherited

Definition at line 48 of file SmoothCircleBaseIC.h.

Referenced by LatticeSmoothCircleIC::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().

◆ _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(), LatticeSmoothCircleIC::initialSetup(), and MultiSmoothCircleIC::initialSetup().

◆ _num_dim

unsigned int SmoothCircleBaseIC::_num_dim

protectedinherited

Definition at line 52 of file SmoothCircleBaseIC.h.

◆ _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 LatticeSmoothCircleIC::computeCircleCenters(), computeCircleCenters(), SmoothCircleIC::computeCircleRadii(), LatticeSmoothCircleIC::computeCircleRadii(), SpecifiedSmoothCircleIC::computeCircleRadii(), MultiSmoothCircleIC::computeCircleRadii(), SmoothCircleFromFileIC::computeCircleRadii(), SmoothCircleBaseIC::gradient(), SmoothCircleBaseIC::initialSetup(), and SmoothCircleBaseIC::value().

◆ _radius

const Real ClosePackIC::_radius

protected

User-supplied circle radius.

Definition at line 37 of file ClosePackIC.h.

Referenced by computeCircleCenters().

◆ _random

MooseRandom SmoothCircleBaseIC::_random

protectedinherited

Definition at line 63 of file SmoothCircleBaseIC.h.

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

◆ _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/ClosePackIC.h
phase_field/src/ics/ClosePackIC.C

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ProfileType

Constructor & Destructor Documentation

◆ ClosePackIC()

Member Function Documentation

◆ computeCircleCenters()

◆ computeCircleGradient()

◆ computeCircleRadii()

◆ computeCircleValue()

◆ gradient()

◆ initialSetup()

◆ value()

Member Data Documentation

◆ _3D_spheres

◆ _centers

◆ _int_width

◆ _invalue

◆ _mesh

◆ _num_dim

◆ _outvalue

◆ _profile

◆ _radii

◆ _radius

◆ _random

◆ _zero_gradient