Reads multiple circles from a text file with the columns labeled x y z r. More...

#include <SmoothCircleFromFileIC.h>

Inheritance diagram for SmoothCircleFromFileIC:

Public Member Functions
	SmoothCircleFromFileIC (const InputParameters &parameters)

virtual Real	value (const Point &p)

virtual RealGradient	gradient (const Point &p)

virtual void	initialSetup ()

Protected Types
enum	COLS { X, Y, Z, R }

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
std::array< int, 4 >	_col_map = {{-1, -1, -1, -1}}

std::vector< std::vector< Real > >	_data

FileName	_file_name

MooseUtils::DelimitedFileReader	_txt_reader

std::vector< std::string >	_col_names

unsigned int	_n_circles

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

Reads multiple circles from a text file with the columns labeled x y z r.

It expects the file to have a one-line header. Applies all of the circles to the same variable.

Definition at line 29 of file SmoothCircleFromFileIC.h.

Member Enumeration Documentation

◆ COLS

enum SmoothCircleFromFileIC::COLS

protected

Enumerator
X
Y
Z
R

Definition at line 38 of file SmoothCircleFromFileIC.h.

   {
     X,
     Y,
     Z,
     R
   };

◆ ProfileType

enum SmoothCircleBaseIC::ProfileType

strongprotectedinherited

Enumerator
COS
TANH

Definition at line 57 of file SmoothCircleBaseIC.h.

   {
     COS,
     TANH
   } _profile;

Constructor & Destructor Documentation

◆ SmoothCircleFromFileIC()

SmoothCircleFromFileIC::SmoothCircleFromFileIC ( const InputParameters & parameters )

Definition at line 25 of file SmoothCircleFromFileIC.C.

   : SmoothCircleBaseIC(parameters),
     _data(0),
     _file_name(getParam<FileName>("file_name")),
     _txt_reader(_file_name, &_communicator),
     _n_circles(0)
 {
   // Read names and vectors from file
   _txt_reader.read();
   _col_names = _txt_reader.getNames();
   _data = _txt_reader.getData();
   _n_circles = _data[0].size();
  
   // Check that the file has all the correct information
   for (unsigned int i = 0; i < _col_names.size(); ++i)
   {
     // Check that columns have uniform lengths
     if (_data[i].size() != _n_circles)
       mooseError("Columns in ", _file_name, " do not have uniform lengths.");
  
     // Determine which columns correspond to which parameters.
     if (_col_names[i] == "x")
       _col_map[X] = i;
     else if (_col_names[i] == "y")
       _col_map[Y] = i;
     else if (_col_names[i] == "z")
       _col_map[Z] = i;
     else if (_col_names[i] == "r")
       _col_map[R] = i;
   }
  
   // Check that the required columns are present
   if (_col_map[X] == -1)
     mooseError("No column in ", _file_name, " labeled 'x'.");
   if (_col_map[Y] == -1)
     mooseError("No column in ", _file_name, " labeled 'y'.");
   if (_col_map[Z] == -1)
     mooseError("No column in ", _file_name, " labeled 'z'.");
   if (_col_map[R] == -1)
     mooseError("No column in ", _file_name, " labeled 'r'.");
 }

Member Function Documentation

◆ computeCircleCenters()

void SmoothCircleFromFileIC::computeCircleCenters ( )

protectedvirtual

Implements SmoothCircleBaseIC.

Definition at line 74 of file SmoothCircleFromFileIC.C.

 {
   _centers.resize(_n_circles);
   for (unsigned int i = 0; i < _n_circles; ++i)
   {
     _centers[i](0) = _data[_col_map[X]][i];
     _centers[i](1) = _data[_col_map[Y]][i];
     _centers[i](2) = _data[_col_map[Z]][i];
   }
 }

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

protectedvirtual

Implements SmoothCircleBaseIC.

Definition at line 68 of file SmoothCircleFromFileIC.C.

 {
   _radii.assign(_data[_col_map[R]].begin(), _data[_col_map[R]].end());
 }

◆ 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;
 }