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 27 of file MultiSmoothCircleIC.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

◆ MultiSmoothCircleIC()

MultiSmoothCircleIC::MultiSmoothCircleIC ( const InputParameters & parameters )

Definition at line 41 of file MultiSmoothCircleIC.C.

   : SmoothCircleBaseIC(parameters),
     _numbub(getParam<unsigned int>("numbub")),
     _bubspac(getParam<Real>("bubspac")),
     _max_num_tries(getParam<unsigned int>("numtries")),
     _radius(getParam<Real>("radius")),
     _radius_variation(getParam<Real>("radius_variation")),
     _radius_variation_type(getParam<MooseEnum>("radius_variation_type"))
 {
 }

Member Function Documentation

◆ computeCircleCenters()

void MultiSmoothCircleIC::computeCircleCenters ( )

overrideprotectedvirtual

Implements SmoothCircleBaseIC.

Reimplemented in PolycrystalVoronoiVoidIC.

Definition at line 96 of file MultiSmoothCircleIC.C.

 {
   _centers.resize(_numbub);
   for (unsigned int i = 0; i < _numbub; ++i)
   {
     // Vary circle center positions
     unsigned int num_tries = 0;
     while (num_tries < _max_num_tries)
     {
       num_tries++;
  
       RealTensorValue ran;
       ran(0, 0) = _random.rand(_tid);
       ran(1, 1) = _random.rand(_tid);
       ran(2, 2) = _random.rand(_tid);
  
       _centers[i] = _bottom_left + ran * _range;
  
       for (unsigned int j = 0; j < i; ++j)
         if (_mesh.minPeriodicDistance(_var.number(), _centers[j], _centers[i]) < _bubspac)
           goto fail;
  
       // accept the position of the new center
       goto accept;
  
     // retry a new position until tries are exhausted
     fail:
       continue;
     }
  
     if (num_tries == _max_num_tries)
       mooseError("Too many tries in MultiSmoothCircleIC");
  
   accept:
     continue;
   }
 }

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

overrideprotectedvirtual

Implements SmoothCircleBaseIC.

Definition at line 72 of file MultiSmoothCircleIC.C.

 {
   _radii.resize(_numbub);
  
   for (unsigned int i = 0; i < _numbub; i++)
   {
     // Vary bubble radius
     switch (_radius_variation_type)
     {
       case 0: // Uniform distribution
         _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;
     }
  
     _radii[i] = std::max(_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 MultiSmoothCircleIC::initialSetup ( )

overridevirtual

Reimplemented from SmoothCircleBaseIC.

Reimplemented in PolycrystalVoronoiVoidIC.

Definition at line 53 of file MultiSmoothCircleIC.C.

 {
   // 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;
  
   // a variation is provided, but the type is set to 'none'
   if (_radius_variation > 0.0 && _radius_variation_type == 2)
     mooseError("If radius_variation > 0.0, you must pass in a radius_variation_type in "
                "MultiSmoothCircleIC");
  
   SmoothCircleBaseIC::initialSetup();
 }

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

◆ _bottom_left

Point MultiSmoothCircleIC::_bottom_left

protected

Definition at line 47 of file MultiSmoothCircleIC.h.

Referenced by computeCircleCenters(), PolycrystalVoronoiVoidIC::computeCircleCenters(), and initialSetup().

◆ _bubspac

const Real MultiSmoothCircleIC::_bubspac

protected

Definition at line 39 of file MultiSmoothCircleIC.h.

Referenced by computeCircleCenters(), and PolycrystalVoronoiVoidIC::computeCircleCenters().

◆ _centers

std::vector<Point> SmoothCircleBaseIC::_centers

protectedinherited

Definition at line 54 of file SmoothCircleBaseIC.h.

Referenced by SmoothCircleIC::computeCircleCenters(), LatticeSmoothCircleIC::computeCircleCenters(), SpecifiedSmoothCircleIC::computeCircleCenters(), ClosePackIC::computeCircleCenters(), SmoothCircleFromFileIC::computeCircleCenters(), 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().

◆ _max_num_tries

const unsigned int MultiSmoothCircleIC::_max_num_tries

protected

Definition at line 41 of file MultiSmoothCircleIC.h.

Referenced by computeCircleCenters(), and PolycrystalVoronoiVoidIC::computeCircleCenters().

◆ _mesh

MooseMesh& SmoothCircleBaseIC::_mesh

protectedinherited

Definition at line 44 of file SmoothCircleBaseIC.h.

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

◆ _num_dim

unsigned int SmoothCircleBaseIC::_num_dim

protectedinherited

Definition at line 52 of file SmoothCircleBaseIC.h.

◆ _numbub

const unsigned int MultiSmoothCircleIC::_numbub

protected

Definition at line 38 of file MultiSmoothCircleIC.h.

Referenced by computeCircleCenters(), PolycrystalVoronoiVoidIC::computeCircleCenters(), computeCircleRadii(), and PolycrystalVoronoiVoidIC::PolycrystalVoronoiVoidIC().

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

◆ _radius

const Real MultiSmoothCircleIC::_radius

protected

Definition at line 43 of file MultiSmoothCircleIC.h.

Referenced by PolycrystalVoronoiVoidIC::computeCircleCenters(), and computeCircleRadii().

◆ _radius_variation

const Real MultiSmoothCircleIC::_radius_variation

protected

Definition at line 44 of file MultiSmoothCircleIC.h.

Referenced by computeCircleRadii(), and initialSetup().

◆ _radius_variation_type

const MooseEnum MultiSmoothCircleIC::_radius_variation_type

protected

Definition at line 45 of file MultiSmoothCircleIC.h.

Referenced by computeCircleRadii(), and initialSetup().

◆ _random

MooseRandom SmoothCircleBaseIC::_random

protectedinherited

Definition at line 63 of file SmoothCircleBaseIC.h.

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

◆ _range

Point MultiSmoothCircleIC::_range

protected

Definition at line 49 of file MultiSmoothCircleIC.h.

Referenced by computeCircleCenters(), PolycrystalVoronoiVoidIC::computeCircleCenters(), and initialSetup().

◆ _top_right

Point MultiSmoothCircleIC::_top_right

protected

Definition at line 48 of file MultiSmoothCircleIC.h.

Referenced by PolycrystalVoronoiVoidIC::computeCircleCenters(), and 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/MultiSmoothCircleIC.h
phase_field/src/ics/MultiSmoothCircleIC.C

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ProfileType

Constructor & Destructor Documentation

◆ MultiSmoothCircleIC()

Member Function Documentation

◆ computeCircleCenters()

◆ computeCircleGradient()

◆ computeCircleRadii()

◆ computeCircleValue()

◆ gradient()

◆ initialSetup()

◆ value()

Member Data Documentation

◆ _3D_spheres

◆ _bottom_left

◆ _bubspac

◆ _centers

◆ _int_width

◆ _invalue

◆ _max_num_tries

◆ _mesh

◆ _num_dim

◆ _numbub

◆ _outvalue

◆ _profile

◆ _radii

◆ _radius

◆ _radius_variation

◆ _radius_variation_type

◆ _random

◆ _range

◆ _top_right

◆ _zero_gradient