PropertyReadFile.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "GeneralUserObject.h"
#include "MooseEnum.h"
#include "DelimitedFileReader.h"

class PropertyReadFile : public GeneralUserObject
{
public:
  static InputParameters validParams();

  PropertyReadFile(const InputParameters & parameters);
  virtual ~PropertyReadFile() {}

  std::vector<FileName> getFileNames();

  virtual void initialize();
  virtual void execute() {}
  virtual void finalize() {}

  void readData();

  virtual void initVoronoiCenterPoints();

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

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

  Real getNodeData(const Node * const node, const unsigned int prop_num) const;

  Real getVoronoiData(const Point & point, const unsigned int prop_num) const;

  Real getBlockData(const Elem * const elem, const unsigned int prop_num) const;

  Real minPeriodicDistance(const Point &, const Point &) const;

  enum class ReadTypeEnum
  {
    ELEMENT = 0,
    VORONOI = 1,
    BLOCK = 2,
    NODE = 3,
    GRAIN = 4
  };

  ReadTypeEnum getReadType() const { return _read_type; }

  unsigned int getNumProperties() const { return _nprop; }

protected:
  std::vector<FileName> _prop_file_names;
  unsigned int & _current_file_index;
  MooseUtils::DelimitedFileReader _reader;

  const ReadTypeEnum _read_type;

  const bool _use_random_tesselation;
  const unsigned int _rand_seed;
  const MooseEnum _rve_type;
  bool _block_zero;

  const unsigned int _ngrain;

  MooseMesh & _mesh;
  std::vector<Point> _center;

private:
  BoundingBox _bounding_box;

  const unsigned int _nprop;
  const unsigned int _nvoronoi;
  const unsigned int _nblock;

  bool & _initialize_called_once;

  const bool _load_on_construction;
};