#include <ElementPropertyReadFile.h>

Inheritance diagram for ElementPropertyReadFile:

Public Member Functions
	ElementPropertyReadFile (const InputParameters &parameters)

virtual	~ElementPropertyReadFile ()

virtual void	initialize ()

virtual void	execute ()

virtual void	finalize ()

void	readElementData ()
	This function reads element data from file. More...

virtual void	readGrainData ()
	This function Read grain data from file. More...

virtual void	initGrainCenterPoints ()
	This function generates grain center point Presently random generated. More...

Real	getData (const Elem *, unsigned int) const
	This function assign property data to elements. More...

Real	getElementData (const Elem *, unsigned int) const
	This function assign properties to element read from file with element based properties. More...

Real	getGrainData (const Elem *, unsigned int) const
	This function assign properties to element read from file with grain based properties Grain distribution in the RVE can be Periodic or non-periodic (default) More...

Real	minPeriodicDistance (Point, Point) const
	This function calculates minimum distance between 2 points considering periodicity of the simulation volume. More...

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
std::string	_prop_file_name
	Name of file containing property values. More...

std::vector< Real >	_data
	Store property values read from file. More...

unsigned int	_nprop
	Number of properties in a row. More...

unsigned int	_ngrain
	Number of grains (for property read based on grains) More...

MooseEnum	_read_type
	Type of read - element or grain. More...

unsigned int	_rand_seed
	Random seed - used for generating grain centers. More...

MooseEnum	_rve_type
	Type of grain structure - non-periodic default. More...

MooseMesh &	_mesh

std::vector< Point >	_center

Private Attributes
unsigned int	_nelem

Point	_top_right

Point	_bottom_left

Point	_range

Real	_max_range

Detailed Description

Definition at line 27 of file ElementPropertyReadFile.h.

Constructor & Destructor Documentation

◆ ElementPropertyReadFile()

ElementPropertyReadFile::ElementPropertyReadFile ( const InputParameters & parameters )

Definition at line 42 of file ElementPropertyReadFile.C.

   : GeneralUserObject(parameters),
     _prop_file_name(getParam<FileName>("prop_file_name")),
     _nprop(getParam<unsigned int>("nprop")),
     _ngrain(getParam<unsigned int>("ngrain")),
     _read_type(getParam<MooseEnum>("read_type")),
     _rand_seed(getParam<unsigned int>("rand_seed")),
     _rve_type(getParam<MooseEnum>("rve_type")),
     _mesh(_fe_problem.mesh())
 {
   _nelem = _mesh.nElem();
  
   for (unsigned int i = 0; i < LIBMESH_DIM; i++)
   {
     _bottom_left(i) = _mesh.getMinInDimension(i);
     _top_right(i) = _mesh.getMaxInDimension(i);
     _range(i) = _top_right(i) - _bottom_left(i);
   }
  
   _max_range = _range(0);
   for (unsigned int i = 1; i < LIBMESH_DIM; i++)
     if (_range(i) > _max_range)
       _max_range = _range(i);
  
   switch (_read_type)
   {
     case 0:
       readElementData();
       break;
  
     case 1:
       readGrainData();
       break;
   }
 }

◆ ~ElementPropertyReadFile()

virtual ElementPropertyReadFile::~ElementPropertyReadFile ( )

inlinevirtual

Definition at line 33 of file ElementPropertyReadFile.h.

33 {}

Member Function Documentation

◆ execute()

virtual void ElementPropertyReadFile::execute ( )

inlinevirtual

Definition at line 36 of file ElementPropertyReadFile.h.

36 {}

◆ finalize()

virtual void ElementPropertyReadFile::finalize ( )

inlinevirtual

Definition at line 37 of file ElementPropertyReadFile.h.

37 {}

◆ getData()

Real ElementPropertyReadFile::getData	(	const Elem *	elem,
		unsigned int	prop_num
	)		const

This function assign property data to elements.

Definition at line 126 of file ElementPropertyReadFile.C.

 {
   switch (_read_type)
   {
     case 0:
       return getElementData(elem, prop_num);
  
     case 1:
       return getGrainData(elem, prop_num);
   }
   mooseError("Error ElementPropertyReadFile: Provide valid read type");
 }

Referenced by ComputeElasticityTensorCP::assignEulerAngles().

◆ getElementData()

Real ElementPropertyReadFile::getElementData	(	const Elem *	elem,
		unsigned int	prop_num
	)		const

This function assign properties to element read from file with element based properties.

Definition at line 140 of file ElementPropertyReadFile.C.

 {
   unsigned int jelem = elem->id();
   mooseAssert(jelem < _nelem,
               "Error ElementPropertyReadFile: Element "
                   << jelem << " greater than than total number of element in mesh " << _nelem);
   mooseAssert(prop_num < _nprop,
               "Error ElementPropertyReadFile: Property number "
                   << prop_num << " greater than than total number of properties " << _nprop);
   return _data[jelem * _nprop + prop_num];
 }

Referenced by getData().

◆ getGrainData()

Real ElementPropertyReadFile::getGrainData	(	const Elem *	elem,
		unsigned int	prop_num
	)		const

This function assign properties to element read from file with grain based properties Grain distribution in the RVE can be Periodic or non-periodic (default)

Definition at line 153 of file ElementPropertyReadFile.C.

 {
   mooseAssert(prop_num < _nprop,
               "Error ElementPropertyReadFile: Property number "
                   << prop_num << " greater than than total number of properties " << _nprop
                   << "\n");
  
   Point centroid = elem->centroid();
   Real min_dist = _max_range;
   unsigned int igrain = 0;
  
   for (unsigned int i = 0; i < _ngrain; ++i)
   {
     Real dist = 0.0;
     switch (_rve_type)
     {
       case 0:
         // Calculates minimum periodic distance when "periodic" is specified
         // for rve_type
         dist = minPeriodicDistance(_center[i], centroid);
         break;
  
       default:
         // Calculates minimum distance when nothing is specified
         // for rve_type
         Point dist_vec = _center[i] - centroid;
         dist = dist_vec.norm();
     }
  
     if (dist < min_dist)
     {
       min_dist = dist;
       igrain = i;
     }
   }
  
   return _data[igrain * _nprop + prop_num];
 }

Referenced by getData().

◆ initGrainCenterPoints()

void ElementPropertyReadFile::initGrainCenterPoints ( )

virtual

This function generates grain center point Presently random generated.

Definition at line 116 of file ElementPropertyReadFile.C.

 {
   _center.resize(_ngrain);
   MooseRandom::seed(_rand_seed);
   for (unsigned int i = 0; i < _ngrain; i++)
     for (unsigned int j = 0; j < LIBMESH_DIM; j++)
       _center[i](j) = _bottom_left(j) + MooseRandom::rand() * _range(j);
 }

Referenced by readGrainData().

◆ initialize()

virtual void ElementPropertyReadFile::initialize ( )

inlinevirtual

Definition at line 35 of file ElementPropertyReadFile.h.

35 {}

◆ minPeriodicDistance()

Real ElementPropertyReadFile::minPeriodicDistance	(	Point	c,
		Point	p
	)		const

This function calculates minimum distance between 2 points considering periodicity of the simulation volume.

Definition at line 194 of file ElementPropertyReadFile.C.

 {
   Point dist_vec = c - p;
   Real min_dist = dist_vec.norm();
  
   Real fac[3] = {-1.0, 0.0, 1.0};
   for (unsigned int i = 0; i < 3; i++)
     for (unsigned int j = 0; j < 3; j++)
       for (unsigned int k = 0; k < 3; k++)
       {
         Point p1;
         p1(0) = p(0) + fac[i] * _range(0);
         p1(1) = p(1) + fac[j] * _range(1);
         p1(2) = p(2) + fac[k] * _range(2);
  
         dist_vec = c - p1;
         Real dist = dist_vec.norm();
  
         if (dist < min_dist)
           min_dist = dist;
       }
  
   return min_dist;
 }

Referenced by getGrainData().

◆ readElementData()

void ElementPropertyReadFile::readElementData ( )

This function reads element data from file.

Definition at line 79 of file ElementPropertyReadFile.C.

 {
   _data.resize(_nprop * _nelem);
  
   MooseUtils::checkFileReadable(_prop_file_name);
  
   std::ifstream file_prop;
   file_prop.open(_prop_file_name.c_str());
  
   for (unsigned int i = 0; i < _nelem; i++)
     for (unsigned int j = 0; j < _nprop; j++)
       if (!(file_prop >> _data[i * _nprop + j]))
         mooseError("Error ElementPropertyReadFile: Premature end of file");
  
   file_prop.close();
 }

Referenced by ElementPropertyReadFile().

◆ readGrainData()

void ElementPropertyReadFile::readGrainData ( )

virtual

This function Read grain data from file.

Definition at line 97 of file ElementPropertyReadFile.C.

 {
   mooseAssert(_ngrain > 0, "Error ElementPropertyReadFile: Provide non-zero number of grains");
   _data.resize(_nprop * _ngrain);
  
   MooseUtils::checkFileReadable(_prop_file_name);
   std::ifstream file_prop;
   file_prop.open(_prop_file_name.c_str());
  
   for (unsigned int i = 0; i < _ngrain; i++)
     for (unsigned int j = 0; j < _nprop; j++)
       if (!(file_prop >> _data[i * _nprop + j]))
         mooseError("Error ElementPropertyReadFile: Premature end of file");
  
   file_prop.close();
   initGrainCenterPoints();
 }

Referenced by ElementPropertyReadFile().

◆ validParams()

InputParameters ElementPropertyReadFile::validParams ( )

static

Definition at line 21 of file ElementPropertyReadFile.C.

 {
   InputParameters params = GeneralUserObject::validParams();
   params.addClassDescription("User Object to read property data from an external file and assign "
                              "to elements.");
   params.addParam<FileName>("prop_file_name", "", "Name of the property file name");
   params.addRequiredParam<unsigned int>("nprop", "Number of tabulated property values");
   params.addParam<unsigned int>("ngrain", 0, "Number of grains");
   params.addRequiredParam<MooseEnum>(
       "read_type",
       MooseEnum("element grain"),
       "Type of property distribution: element:element by element property "
       "variation; grain:voronoi grain structure");
   params.addParam<unsigned int>("rand_seed", 2000, "random seed");
   params.addParam<MooseEnum>(
       "rve_type",
       MooseEnum("periodic none", "none"),
       "Periodic or non-periodic grain distribution: Default is non-periodic");
   return params;
 }

Member Data Documentation

◆ _bottom_left

Point ElementPropertyReadFile::_bottom_left

private

Definition at line 99 of file ElementPropertyReadFile.h.

Referenced by ElementPropertyReadFile(), and initGrainCenterPoints().

◆ _center

std::vector<Point> ElementPropertyReadFile::_center

protected

Definition at line 94 of file ElementPropertyReadFile.h.

Referenced by getGrainData(), and initGrainCenterPoints().

◆ _data

std::vector<Real> ElementPropertyReadFile::_data

protected

Store property values read from file.

Definition at line 81 of file ElementPropertyReadFile.h.

Referenced by getElementData(), getGrainData(), readElementData(), and readGrainData().

◆ _max_range

Real ElementPropertyReadFile::_max_range

private

Definition at line 101 of file ElementPropertyReadFile.h.

Referenced by ElementPropertyReadFile(), and getGrainData().

◆ _mesh

MooseMesh& ElementPropertyReadFile::_mesh

protected

Definition at line 93 of file ElementPropertyReadFile.h.

Referenced by ElementPropertyReadFile().

◆ _nelem

unsigned int ElementPropertyReadFile::_nelem

private

Definition at line 97 of file ElementPropertyReadFile.h.

Referenced by ElementPropertyReadFile(), getElementData(), and readElementData().

◆ _ngrain

unsigned int ElementPropertyReadFile::_ngrain

protected

Number of grains (for property read based on grains)

Definition at line 85 of file ElementPropertyReadFile.h.

Referenced by getGrainData(), initGrainCenterPoints(), and readGrainData().

◆ _nprop

unsigned int ElementPropertyReadFile::_nprop

protected

Number of properties in a row.

Definition at line 83 of file ElementPropertyReadFile.h.

Referenced by getElementData(), getGrainData(), readElementData(), and readGrainData().

◆ _prop_file_name

std::string ElementPropertyReadFile::_prop_file_name

protected

Name of file containing property values.

Definition at line 79 of file ElementPropertyReadFile.h.

Referenced by readElementData(), and readGrainData().

◆ _rand_seed

unsigned int ElementPropertyReadFile::_rand_seed

protected

Random seed - used for generating grain centers.

Definition at line 89 of file ElementPropertyReadFile.h.

Referenced by initGrainCenterPoints().

◆ _range

Point ElementPropertyReadFile::_range

private

Definition at line 100 of file ElementPropertyReadFile.h.

Referenced by ElementPropertyReadFile(), initGrainCenterPoints(), and minPeriodicDistance().

◆ _read_type

MooseEnum ElementPropertyReadFile::_read_type

protected

Type of read - element or grain.

Definition at line 87 of file ElementPropertyReadFile.h.

Referenced by ElementPropertyReadFile(), and getData().

◆ _rve_type

MooseEnum ElementPropertyReadFile::_rve_type

protected

Type of grain structure - non-periodic default.

Definition at line 91 of file ElementPropertyReadFile.h.

Referenced by getGrainData().

◆ _top_right

Point ElementPropertyReadFile::_top_right

private

Definition at line 98 of file ElementPropertyReadFile.h.

Referenced by ElementPropertyReadFile().

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

tensor_mechanics/include/userobjects/ElementPropertyReadFile.h
tensor_mechanics/src/userobjects/ElementPropertyReadFile.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ElementPropertyReadFile()

◆ ~ElementPropertyReadFile()

Member Function Documentation

◆ execute()

◆ finalize()

◆ getData()

◆ getElementData()

◆ getGrainData()

◆ initGrainCenterPoints()

◆ initialize()

◆ minPeriodicDistance()

◆ readElementData()

◆ readGrainData()

◆ validParams()

Member Data Documentation

◆ _bottom_left

◆ _center

◆ _data

◆ _max_range

◆ _mesh

◆ _nelem

◆ _ngrain

◆ _nprop

◆ _prop_file_name

◆ _rand_seed

◆ _range

◆ _read_type

◆ _rve_type

◆ _top_right