RndBoundingBoxIC Class Reference

RndBoundingBoxIC allows setting the initial condition of a value inside and outside of a specified box. More...

#include <RndBoundingBoxIC.h>

Inheritance diagram for RndBoundingBoxIC:

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

Private Attributes
const Real	_x1
const Real	_y1
const Real	_z1
const Real	_x2
const Real	_y2
const Real	_z2
const Real	_mx_invalue
const Real	_mx_outvalue
const Real	_mn_invalue
const Real	_mn_outvalue
const Real	_range_invalue
const Real	_range_outvalue
const Point	_bottom_left
const Point	_top_right

Detailed Description

RndBoundingBoxIC allows setting the initial condition of a value inside and outside of a specified box.

The box is aligned with the x,y,z axis... and is specified by passing in the x,y,z coordinates of the bottom left point and the top right point. Each of the coordinates of the "bottom_left" point MUST be less than those coordinates in the "top_right" point.

When setting the initial condition if bottom_left <= Point <= top_right then the "inside" value is used. Otherwise the "outside" value is used.

Definition at line 33 of file RndBoundingBoxIC.h.

Constructor & Destructor Documentation

RndBoundingBoxIC()

RndBoundingBoxIC::RndBoundingBoxIC

(

const InputParameters &

parameters

)

Definition at line 39 of file RndBoundingBoxIC.C.

  : InitialCondition(parameters),
    _x1(parameters.get<Real>("x1")),
    _y1(parameters.get<Real>("y1")),
    _z1(parameters.get<Real>("z1")),
    _x2(parameters.get<Real>("x2")),
    _y2(parameters.get<Real>("y2")),
    _z2(parameters.get<Real>("z2")),
    _mx_invalue(parameters.get<Real>("mx_invalue")),
    _mx_outvalue(parameters.get<Real>("mx_outvalue")),
    _mn_invalue(parameters.get<Real>("mn_invalue")),
    _mn_outvalue(parameters.get<Real>("mn_outvalue")),
    _range_invalue(_mx_invalue - _mn_invalue),
    _range_outvalue(_mx_outvalue - _mn_outvalue),
    _bottom_left(_x1, _y1, _z1),
    _top_right(_x2, _y2, _z2)
{
  mooseAssert(_range_invalue >= 0.0, "Inside Min > Inside Max for RandomIC!");
  mooseAssert(_range_outvalue >= 0.0, "Outside Min > Outside Max for RandomIC!");
}

Member Function Documentation

value()

Real RndBoundingBoxIC::value ( const Point &  p )

virtual

Definition at line 61 of file RndBoundingBoxIC.C.

{
  // Random number between 0 and 1
  Real rand_num = MooseRandom::rand();
 
  for (unsigned int i = 0; i < LIBMESH_DIM; ++i)
    if (p(i) < _bottom_left(i) || p(i) > _top_right(i))
      return rand_num * _range_outvalue + _mn_outvalue;
 
  return rand_num * _range_invalue + _mn_invalue;
}

Member Data Documentation

_bottom_left

const Point RndBoundingBoxIC::_bottom_left

private

Definition at line 54 of file RndBoundingBoxIC.h.

Referenced by value().

_mn_invalue

const Real RndBoundingBoxIC::_mn_invalue

private

Definition at line 49 of file RndBoundingBoxIC.h.

Referenced by value().

_mn_outvalue

const Real RndBoundingBoxIC::_mn_outvalue

private

Definition at line 50 of file RndBoundingBoxIC.h.

Referenced by value().

_mx_invalue

const Real RndBoundingBoxIC::_mx_invalue

private

Definition at line 47 of file RndBoundingBoxIC.h.

_mx_outvalue

const Real RndBoundingBoxIC::_mx_outvalue

private

Definition at line 48 of file RndBoundingBoxIC.h.

_range_invalue

const Real RndBoundingBoxIC::_range_invalue

private

Definition at line 51 of file RndBoundingBoxIC.h.

Referenced by RndBoundingBoxIC(), and value().

_range_outvalue

const Real RndBoundingBoxIC::_range_outvalue

private

Definition at line 52 of file RndBoundingBoxIC.h.

Referenced by RndBoundingBoxIC(), and value().

_top_right

const Point RndBoundingBoxIC::_top_right

private

Definition at line 55 of file RndBoundingBoxIC.h.

Referenced by value().

_x1

const Real RndBoundingBoxIC::_x1

private

Definition at line 41 of file RndBoundingBoxIC.h.

_x2

const Real RndBoundingBoxIC::_x2

private

Definition at line 44 of file RndBoundingBoxIC.h.

_y1

const Real RndBoundingBoxIC::_y1

private

Definition at line 42 of file RndBoundingBoxIC.h.

_y2

const Real RndBoundingBoxIC::_y2

private

Definition at line 45 of file RndBoundingBoxIC.h.

_z1

const Real RndBoundingBoxIC::_z1

private

Definition at line 43 of file RndBoundingBoxIC.h.

_z2

const Real RndBoundingBoxIC::_z2

private

Definition at line 46 of file RndBoundingBoxIC.h.

---

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

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