SmoothCircleBaseIC Class Reference

SmoothcircleBaseIC is the base class for all initial conditions that create circles. More...

#include <SmoothCircleBaseIC.h>

Inheritance diagram for SmoothCircleBaseIC:

Public Member Functions
	SmoothCircleBaseIC (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 Real	computeCircleValue (const Point &p, const Point &center, const Real &radius)
virtual RealGradient	computeCircleGradient (const Point &p, const Point &center, const Real &radius)
virtual void	computeCircleRadii ()=0
virtual void	computeCircleCenters ()=0

Protected Attributes
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

SmoothcircleBaseIC is the base class for all initial conditions that create circles.

The circles can have sharp interfaces or a finite interface width. Note that all children must resize _radii and _centers.

Definition at line 26 of file SmoothCircleBaseIC.h.

Member Enumeration Documentation

ProfileType

enum SmoothCircleBaseIC::ProfileType

strongprotected

Enumerator
COS
TANH

Definition at line 57 of file SmoothCircleBaseIC.h.

  {
    COS,
    TANH
  } _profile;

Constructor & Destructor Documentation

SmoothCircleBaseIC()

SmoothCircleBaseIC::SmoothCircleBaseIC

(

const InputParameters &

parameters

)

Definition at line 38 of file SmoothCircleBaseIC.C.

  : InitialCondition(parameters),
    _mesh(_fe_problem.mesh()),
    _invalue(parameters.get<Real>("invalue")),
    _outvalue(parameters.get<Real>("outvalue")),
    _int_width(parameters.get<Real>("int_width")),
    _3D_spheres(parameters.get<bool>("3D_spheres")),
    _zero_gradient(parameters.get<bool>("zero_gradient")),
    _num_dim(_3D_spheres ? 3 : 2),
    _profile(getParam<MooseEnum>("profile").getEnum<ProfileType>())
{
  _random.seed(_tid, getParam<unsigned int>("rand_seed"));
 
  if (_int_width <= 0.0 && _profile == ProfileType::TANH)
    paramError("int_width",
               "Interface width has to be strictly positive for the hyperbolic tangent profile");
}

Member Function Documentation

computeCircleCenters()

virtual void SmoothCircleBaseIC::computeCircleCenters ( )

protectedpure virtual

Implemented in PolycrystalVoronoiVoidIC, MultiSmoothCircleIC, SmoothCircleFromFileIC, ClosePackIC, LatticeSmoothCircleIC, SpecifiedSmoothCircleIC, and SmoothCircleIC.

Referenced by initialSetup().

computeCircleGradient()

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

protectedvirtual

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

computeCircleRadii()

virtual void SmoothCircleBaseIC::computeCircleRadii ( )

protectedpure virtual

Implemented in MultiSmoothCircleIC, SmoothCircleFromFileIC, LatticeSmoothCircleIC, SpecifiedSmoothCircleIC, ClosePackIC, and SmoothCircleIC.

Referenced by initialSetup().

computeCircleValue()

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

protectedvirtual

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 gradient(), and value().

gradient()

RealGradient SmoothCircleBaseIC::gradient ( const Point &  p )

virtual

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

virtual

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 )

virtual

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(), computeCircleValue(), gradient(), and PolycrystalVoronoiVoidIC::value().

Member Data Documentation

_3D_spheres

bool SmoothCircleBaseIC::_3D_spheres

protected

Definition at line 49 of file SmoothCircleBaseIC.h.

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

_centers

std::vector<Point> SmoothCircleBaseIC::_centers

protected

Definition at line 54 of file SmoothCircleBaseIC.h.

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

_int_width

Real SmoothCircleBaseIC::_int_width

protected

Definition at line 48 of file SmoothCircleBaseIC.h.

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

_invalue

Real SmoothCircleBaseIC::_invalue

protected

Definition at line 46 of file SmoothCircleBaseIC.h.

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

_mesh

MooseMesh& SmoothCircleBaseIC::_mesh

protected

Definition at line 44 of file SmoothCircleBaseIC.h.

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

_num_dim

unsigned int SmoothCircleBaseIC::_num_dim

protected

Definition at line 52 of file SmoothCircleBaseIC.h.

_outvalue

Real SmoothCircleBaseIC::_outvalue

protected

Definition at line 47 of file SmoothCircleBaseIC.h.

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

_profile

enum SmoothCircleBaseIC::ProfileType SmoothCircleBaseIC::_profile

protected

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

_radii

std::vector<Real> SmoothCircleBaseIC::_radii

protected

Definition at line 55 of file SmoothCircleBaseIC.h.

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

_random

MooseRandom SmoothCircleBaseIC::_random

protected

Definition at line 63 of file SmoothCircleBaseIC.h.

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

_zero_gradient

bool SmoothCircleBaseIC::_zero_gradient

protected

Definition at line 50 of file SmoothCircleBaseIC.h.

Referenced by gradient().

---

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

• phase_field/include/ics/SmoothCircleBaseIC.h
• phase_field/src/ics/SmoothCircleBaseIC.C