LineMaterialSamplerBase.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
 
// MOOSE includes
#include "GeneralVectorPostprocessor.h"
#include "SamplerBase.h"
#include "BlockRestrictable.h"
#include "LineSegment.h"
#include "RayTracing.h" // Moose::elementsIntersectedByLine()
#include "Assembly.h"   // Assembly::qRule()
#include "MooseMesh.h"  // MooseMesh::getMesh()
#include "SwapBackSentinel.h"
#include "FEProblem.h"
 
#include "libmesh/quadrature.h" // _qrule->n_points()
 
// Forward Declarations
class MooseMesh;
 
template <typename T>
class LineMaterialSamplerBase : public GeneralVectorPostprocessor,
                                public SamplerBase,
                                public BlockRestrictable
{
public:
  static InputParameters validParams();
 
  LineMaterialSamplerBase(const InputParameters & parameters);
 
  virtual void initialize() override;
 
  virtual void execute() override;
 
  virtual void finalize() override;
 
  virtual Real getScalarFromProperty(const T & property, const Point & curr_point) = 0;
 
protected:
  Point _start;
 
  Point _end;
 
  std::vector<const MaterialProperty<T> *> _material_properties;
 
  MooseMesh & _mesh;
 
  const QBase * const & _qrule;
 
  const MooseArray<Point> & _q_point;
};
 
template <typename T>
InputParameters
LineMaterialSamplerBase<T>::validParams()
{
  InputParameters params = GeneralVectorPostprocessor::validParams();
  params += SamplerBase::validParams();
  params += BlockRestrictable::validParams();
  params.addRequiredParam<Point>("start", "The beginning of the line");
  params.addRequiredParam<Point>("end", "The end of the line");
  params.addRequiredParam<std::vector<std::string>>(
      "property", "Name of the material property to be output along a line");
 
  return params;
}
 
template <typename T>
LineMaterialSamplerBase<T>::LineMaterialSamplerBase(const InputParameters & parameters)
  : GeneralVectorPostprocessor(parameters),
    SamplerBase(parameters, this, _communicator),
    BlockRestrictable(this),
    _start(getParam<Point>("start")),
    _end(getParam<Point>("end")),
    _mesh(_subproblem.mesh()),
    _qrule(_subproblem.assembly(_tid, 0).qRule()),
    _q_point(_subproblem.assembly(_tid, 0).qPoints())
{
  // See https://github.com/idaholab/moose/issues/21865
  _mesh.errorIfDistributedMesh("LineMaterialSamplerBase");
 
  std::vector<std::string> material_property_names = getParam<std::vector<std::string>>("property");
  for (unsigned int i = 0; i < material_property_names.size(); ++i)
  {
    if (!hasMaterialProperty<T>(material_property_names[i]))
      mooseError("In LineMaterialSamplerBase material property: " + material_property_names[i] +
                 " does not exist.");
    _material_properties.push_back(&getMaterialProperty<T>(material_property_names[i]));
  }
 
  SamplerBase::setupVariables(material_property_names);
}
 
template <typename T>
void
LineMaterialSamplerBase<T>::initialize()
{
  SamplerBase::initialize();
}
 
template <typename T>
void
LineMaterialSamplerBase<T>::execute()
{
  std::vector<Elem *> intersected_elems;
  std::vector<LineSegment> segments;
 
  std::unique_ptr<libMesh::PointLocatorBase> pl = _mesh.getPointLocator();
  Moose::elementsIntersectedByLine(_start, _end, _mesh, *pl, intersected_elems, segments);
 
  const RealVectorValue line_vec = _end - _start;
  const Real line_length(line_vec.norm());
  const RealVectorValue line_unit_vec = line_vec / line_length;
  std::vector<Real> values(_material_properties.size());
 
  std::unordered_set<unsigned int> needed_mat_props;
  const auto & mp_deps = getMatPropDependencies();
  needed_mat_props.insert(mp_deps.begin(), mp_deps.end());
  _fe_problem.setActiveMaterialProperties(needed_mat_props, _tid);
 
  for (const auto & elem : intersected_elems)
  {
    if (elem->processor_id() != processor_id())
      continue;
 
    if (!hasBlocks(elem->subdomain_id()))
      continue;
 
    _subproblem.setCurrentSubdomainID(elem, _tid);
    _subproblem.prepare(elem, _tid);
    _subproblem.reinitElem(elem, _tid);
 
    // Set up Sentinel class so that, even if reinitMaterials() throws, we
    // still remember to swap back during stack unwinding.
    SwapBackSentinel sentinel(_fe_problem, &FEProblem::swapBackMaterials, _tid);
    _fe_problem.reinitMaterials(elem->subdomain_id(), _tid);
 
    for (unsigned int qp = 0; qp < _qrule->n_points(); ++qp)
    {
      const RealVectorValue qp_pos(_q_point[qp]);
 
      const RealVectorValue start_to_qp(qp_pos - _start);
      const Real qp_proj_dist_along_line = start_to_qp * line_unit_vec;
 
      if (qp_proj_dist_along_line < 0 || qp_proj_dist_along_line > line_length)
        continue;
 
      for (unsigned int j = 0; j < _material_properties.size(); ++j)
        values[j] = getScalarFromProperty((*_material_properties[j])[qp], _q_point[qp]);
 
      addSample(_q_point[qp], qp_proj_dist_along_line, values);
    }
  }
  _fe_problem.clearActiveMaterialProperties(_tid);
}
 
template <typename T>
void
LineMaterialSamplerBase<T>::finalize()
{
  SamplerBase::finalize();
}