PFCFreezingIC Class Reference

PFCFreezingIC creates an initial density for a PFC model that has one area of a set crystal structure (initialized using sinusoids) and all the rest with a random structure. More...

#include <PFCFreezingIC.h>

Inheritance diagram for PFCFreezingIC:

Public Member Functions
	PFCFreezingIC (const InputParameters &parameters)
virtual Real	value (const Point &p)

Private Attributes
Real	_x1
Real	_y1
Real	_z1
Real	_x2
Real	_y2
Real	_z2
Real	_lc
MooseEnum	_crystal_structure
Point	_bottom_left
Point	_top_right
Point	_range
Real	_min
Real	_max
Real	_val_range
Real	_inside
Real	_outside
unsigned int	_icdim

Detailed Description

PFCFreezingIC creates an initial density for a PFC model that has one area of a set crystal structure (initialized using sinusoids) and all the rest with a random structure.

The random values will fall between 0 and 1.

Definition at line 27 of file PFCFreezingIC.h.

Constructor & Destructor Documentation

PFCFreezingIC()

PFCFreezingIC::PFCFreezingIC

(

const InputParameters &

parameters

)

Definition at line 44 of file PFCFreezingIC.C.

  : RandomICBase(parameters),
    _x1(getParam<Real>("x1")),
    _y1(getParam<Real>("y1")),
    _z1(getParam<Real>("z1")),
    _x2(getParam<Real>("x2")),
    _y2(getParam<Real>("y2")),
    _z2(getParam<Real>("z2")),
    _lc(getParam<Real>("lc")),
    _crystal_structure(getParam<MooseEnum>("crystal_structure")),
    _bottom_left(_x1, _y1, _z1),
    _top_right(_x2, _y2, _z2),
    _range(_top_right - _bottom_left),
    _min(getParam<Real>("min")),
    _max(getParam<Real>("max")),
    _val_range(_max - _min),
    _inside(getParam<Real>("inside")),
    _outside(getParam<Real>("outside"))
{
  _console << "MooseEnum? " << _crystal_structure << std::endl;
 
  for (unsigned int i = 0; i < LIBMESH_DIM; i++)
    mooseAssert(_range(i) >= 0.0, "x1, y1 or z1 is not less than x2, y2 or z2");
 
  if (_range(1) == 0.0)
    _icdim = 1;
  else if (_range(2) < 1.0e-10 * _range(0))
    _icdim = 2;
  else
    _icdim = 3;
}

Member Function Documentation

value()

Real PFCFreezingIC::value ( const Point &  p )

virtual

Definition at line 77 of file PFCFreezingIC.C.

{
  // If out of bounds, set random value
  for (unsigned int i = 0; i < LIBMESH_DIM; i++)
    if (p(i) < _bottom_left(i) || p(i) > _top_right(i))
      return _min + _val_range * generateRandom();
 
  // If in bounds, set sinusoid IC to make atoms
  Real val = 0.0;
  if (_crystal_structure == "FCC")
  {
    // Note: this effectively (and now explicitly) returns 0.0 for FCC.
    return 0.0;
 
    for (unsigned int i = 0; i < _icdim; i++)
      val += std::cos((2.0 / _lc * p(i)) * libMesh::pi);
  }
  else
  {
    if (_icdim > 2)
    {
      for (unsigned int i = 0; i < _icdim; i++)
        // one mode approximation for initial condition
        val += (std::cos((2.0 / _lc * p(i % 3)) * libMesh::pi) *
                std::cos((2.0 / _lc * p((i + 1) % 3)) * libMesh::pi)) /
               4.0; // Doesn't work in 2D
    }
    else
    {
      for (unsigned int i = 0; i < _icdim; i++)
        val *= std::cos((2.0 / _lc * p(i)) * libMesh::pi); // 2D IC for 111 plane
 
      val = val / 2.0 + 0.5;
    }
  }
 
  Real amp = _inside - _outside;
  val = amp * val + _outside;
 
  return val;
}

Member Data Documentation

_bottom_left

Point PFCFreezingIC::_bottom_left

private

Definition at line 46 of file PFCFreezingIC.h.

Referenced by value().

_crystal_structure

MooseEnum PFCFreezingIC::_crystal_structure

private

Definition at line 44 of file PFCFreezingIC.h.

Referenced by PFCFreezingIC(), and value().

_icdim

unsigned int PFCFreezingIC::_icdim

private

Definition at line 53 of file PFCFreezingIC.h.

Referenced by PFCFreezingIC(), and value().

_inside

Real PFCFreezingIC::_inside

private

Definition at line 51 of file PFCFreezingIC.h.

Referenced by value().

_lc

Real PFCFreezingIC::_lc

private

Definition at line 43 of file PFCFreezingIC.h.

Referenced by value().

_max

Real PFCFreezingIC::_max

private

Definition at line 50 of file PFCFreezingIC.h.

_min

Real PFCFreezingIC::_min

private

Definition at line 50 of file PFCFreezingIC.h.

Referenced by value().

_outside

Real PFCFreezingIC::_outside

private

Definition at line 51 of file PFCFreezingIC.h.

Referenced by value().

_range

Point PFCFreezingIC::_range

private

Definition at line 48 of file PFCFreezingIC.h.

Referenced by PFCFreezingIC().

_top_right

Point PFCFreezingIC::_top_right

private

Definition at line 47 of file PFCFreezingIC.h.

Referenced by value().

_val_range

Real PFCFreezingIC::_val_range

private

Definition at line 50 of file PFCFreezingIC.h.

Referenced by value().

_x1

Real PFCFreezingIC::_x1

private

Definition at line 35 of file PFCFreezingIC.h.

_x2

Real PFCFreezingIC::_x2

private

Definition at line 39 of file PFCFreezingIC.h.

_y1

Real PFCFreezingIC::_y1

private

Definition at line 36 of file PFCFreezingIC.h.

_y2

Real PFCFreezingIC::_y2

private

Definition at line 40 of file PFCFreezingIC.h.

_z1

Real PFCFreezingIC::_z1

private

Definition at line 37 of file PFCFreezingIC.h.

_z2

Real PFCFreezingIC::_z2

private

Definition at line 41 of file PFCFreezingIC.h.

---

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

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