RndSmoothcircleIC creates a smooth circle with a random distribution of values inside and outside of the circle. More...

#include <RndSmoothCircleIC.h>

Inheritance diagram for RndSmoothCircleIC:

[legend]

Public Member Functions
	RndSmoothCircleIC (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 ()

virtual void	computeCircleCenters ()

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

Protected Attributes
Real	_x1

Real	_y1

Real	_z1

Real	_radius

Point	_center

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

Private Member Functions
virtual Real	computeCircleValue (const Point &p, const Point &center, const Real &radius)

Private Attributes
const Real	_variation_invalue

const Real	_variation_outvalue

Detailed Description

RndSmoothcircleIC creates a smooth circle with a random distribution of values inside and outside of the circle.

Definition at line 24 of file RndSmoothCircleIC.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

◆ RndSmoothCircleIC()

RndSmoothCircleIC::RndSmoothCircleIC ( const InputParameters & parameters )

Definition at line 30 of file RndSmoothCircleIC.C.

   : SmoothCircleIC(parameters),
     _variation_invalue(parameters.get<Real>("variation_invalue")),
     _variation_outvalue(parameters.get<Real>("variation_outvalue"))
 {
   if (_profile == ProfileType::TANH)
     paramError("profile", "Hyperbolic tangent profile is not supported for this IC");
 }

Member Function Documentation

◆ computeCircleCenters()

void SmoothCircleIC::computeCircleCenters ( )

protectedvirtualinherited

Implements SmoothCircleBaseIC.

Definition at line 44 of file SmoothCircleIC.C.

 {
   _centers = {_center};
 }

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

protectedvirtualinherited

Implements SmoothCircleBaseIC.

Definition at line 38 of file SmoothCircleIC.C.

 {
   _radii = {_radius};
 }

◆ computeCircleValue()

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

privatevirtual

Reimplemented from SmoothCircleBaseIC.

Definition at line 40 of file RndSmoothCircleIC.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);
  
   // Return value
   Real value = 0.0;
  
   if (dist <= radius - _int_width / 2.0) // Random value inside circle
     value = _invalue - _variation_invalue + 2.0 * _random.rand(_tid) * _variation_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;
   }
   else // Random value outside circle
     value = _outvalue - _variation_outvalue + 2.0 * _random.rand(_tid) * _variation_outvalue;
  
   return 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 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(), computeCircleValue(), and SmoothCircleBaseIC::computeCircleValue().

◆ _center

Point SmoothCircleIC::_center

protectedinherited

Definition at line 38 of file SmoothCircleIC.h.

Referenced by SmoothCircleIC::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(), 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(), computeCircleValue(), SmoothCircleBaseIC::computeCircleValue(), and SmoothCircleBaseIC::SmoothCircleBaseIC().

◆ _invalue

Real SmoothCircleBaseIC::_invalue

protectedinherited

Definition at line 46 of file SmoothCircleBaseIC.h.

Referenced by SmoothCircleBaseIC::computeCircleGradient(), 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(), 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(), 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(), 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(), MultiSmoothCircleIC::computeCircleRadii(), SmoothCircleFromFileIC::computeCircleRadii(), SmoothCircleBaseIC::gradient(), SmoothCircleBaseIC::initialSetup(), and SmoothCircleBaseIC::value().

◆ _radius

Real SmoothCircleIC::_radius

protectedinherited

Definition at line 37 of file SmoothCircleIC.h.

Referenced by SmoothCircleIC::computeCircleRadii().

◆ _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(), computeCircleValue(), and SmoothCircleBaseIC::SmoothCircleBaseIC().

◆ _variation_invalue

const Real RndSmoothCircleIC::_variation_invalue

private

Definition at line 32 of file RndSmoothCircleIC.h.

Referenced by computeCircleValue().

◆ _variation_outvalue

const Real RndSmoothCircleIC::_variation_outvalue

private

Definition at line 33 of file RndSmoothCircleIC.h.

Referenced by computeCircleValue().

◆ _x1

Real SmoothCircleIC::_x1

protectedinherited

Definition at line 34 of file SmoothCircleIC.h.

◆ _y1

Real SmoothCircleIC::_y1

protectedinherited

Definition at line 35 of file SmoothCircleIC.h.

◆ _z1

Real SmoothCircleIC::_z1

protectedinherited

Definition at line 36 of file SmoothCircleIC.h.

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ProfileType

Constructor & Destructor Documentation

◆ RndSmoothCircleIC()

Member Function Documentation

◆ computeCircleCenters()

◆ computeCircleGradient()

◆ computeCircleRadii()

◆ computeCircleValue()

◆ gradient()

◆ initialSetup()

◆ value()

Member Data Documentation

◆ _3D_spheres

◆ _center

◆ _centers

◆ _int_width

◆ _invalue

◆ _mesh

◆ _num_dim

◆ _outvalue

◆ _profile

◆ _radii

◆ _radius

◆ _random

◆ _variation_invalue

◆ _variation_outvalue

◆ _x1

◆ _y1

◆ _z1

◆ _zero_gradient