SolutionRasterizer Class Reference

This Userobject is the base class of Userobjects that generate one random number per timestep and quadrature point in a way that the integral over all random numbers is zero. More...

#include <SolutionRasterizer.h>

Inheritance diagram for SolutionRasterizer:

Public Member Functions
	SolutionRasterizer (const InputParameters &parameters)
virtual	~SolutionRasterizer ()
virtual void	initialSetup ()
	Initialize the System and Mesh objects for the solution being read. More...

Protected Attributes
FileName	_xyz_input
FileName	_xyz_output
std::string	_variable
MooseEnum	_raster_mode
Real	_threshold

Detailed Description

This Userobject is the base class of Userobjects that generate one random number per timestep and quadrature point in a way that the integral over all random numbers is zero.

This can be used for a concentration fluctuation kernel such as ConservedLangevinNoise, that keeps the total concenration constant.

See also

ConservedUniformNoise

Definition at line 28 of file SolutionRasterizer.h.

Constructor & Destructor Documentation

SolutionRasterizer()

SolutionRasterizer::SolutionRasterizer

(

const InputParameters &

parameters

)

Definition at line 34 of file SolutionRasterizer.C.

  : SolutionUserObject(parameters),
    _xyz_input(getParam<FileName>("xyz_input")),
    _xyz_output(getParam<FileName>("xyz_output")),
    _variable(getParam<std::string>("variable")),
    _raster_mode(getParam<MooseEnum>("raster_mode")),
    _threshold(0.0)
{
  if (_raster_mode == "FILTER")
  {
    if (!isParamValid("threshold"))
      mooseError("Please specify 'threshold' parameter for raster_mode = FILTER");
    _threshold = getParam<Real>("threshold");
  }
}

~SolutionRasterizer()

virtual SolutionRasterizer::~SolutionRasterizer ( )

inlinevirtual

Definition at line 33 of file SolutionRasterizer.h.

{}

Member Function Documentation

initialSetup()

void SolutionRasterizer::initialSetup ( )

virtual

Initialize the System and Mesh objects for the solution being read.

Definition at line 51 of file SolutionRasterizer.C.

{
  // only execute once
  if (_initialized)
    return;
 
  // initialize parent class
  SolutionUserObject::initialSetup();
 
  // open input XYZ file
  std::ifstream stream_in(_xyz_input.c_str());
 
  // open output XYZ file
  std::ofstream stream_out(_xyz_output.c_str());
 
  std::string line, dummy;
  Real x, y, z;
  unsigned int current_line = 0;
  unsigned int nfilter = 0, len0 = 0;
  while (std::getline(stream_in, line))
  {
    if (current_line < 2)
    {
      // dump header
      stream_out << line << '\n';
 
      // get length of line 0 - the amount of space we have to replace the atom count at the end of
      // filtering
      if (current_line == 0)
        len0 = line.size();
    }
    else
    {
      std::istringstream iss(line);
 
      if (iss >> dummy >> x >> y >> z)
        switch (_raster_mode)
        {
          case 0: // MAP
            stream_out << line << ' ' << pointValue(0.0, Point(x, y, z), _variable) << '\n';
            break;
          case 1: // FILTER
            if (pointValue(0.0, Point(x, y, z), _variable) > _threshold)
            {
              stream_out << line << '\n';
              nfilter++;
            }
            break;
        }
    }
 
    current_line++;
  }
 
  stream_in.close();
  stream_out.close();
 
  // modify output file to fix atom count in line 0
  if (_raster_mode == "FILTER")
  {
    // stringify the new number of atoms
    std::ostringstream oss;
    oss << nfilter;
    std::string newline0 = oss.str();
 
    // the new number should always be lower -> shorter than the old one, but we check to be sure
    if (newline0.size() > len0)
    {
      mooseWarning("SolutionRasterizer could not update XYZ atom count in header.");
      return;
    }
 
    // pad shorter numbers with spaces
    while (newline0.size() < len0)
      newline0 += ' ';
 
    // inject new number into the file
    std::ofstream stream_fix(_xyz_output.c_str(), std::ios::binary | std::ios::in | std::ios::out);
    stream_fix << newline0;
    stream_fix.close();
  }
}

Member Data Documentation

_raster_mode

MooseEnum SolutionRasterizer::_raster_mode

protected

Definition at line 44 of file SolutionRasterizer.h.

Referenced by initialSetup(), and SolutionRasterizer().

_threshold

Real SolutionRasterizer::_threshold

protected

Definition at line 46 of file SolutionRasterizer.h.

Referenced by initialSetup(), and SolutionRasterizer().

_variable

std::string SolutionRasterizer::_variable

protected

Definition at line 42 of file SolutionRasterizer.h.

Referenced by initialSetup().

_xyz_input

FileName SolutionRasterizer::_xyz_input

protected

Definition at line 39 of file SolutionRasterizer.h.

Referenced by initialSetup().

_xyz_output

FileName SolutionRasterizer::_xyz_output

protected

Definition at line 40 of file SolutionRasterizer.h.

Referenced by initialSetup().

---

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

• phase_field/include/userobjects/SolutionRasterizer.h
• phase_field/src/userobjects/SolutionRasterizer.C