www.mooseframework.org
PiecewiseLinearInterpolationMaterial.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
11 
12 // MOOSE includes
13 #include "MooseVariableFE.h"
14 
16 
17 template <>
20 {
22  params.addClassDescription("Compute a property using a piecewise linear interpolation to define "
23  "its dependence on a variable");
24  params.addRequiredParam<std::string>("property",
25  "The name of the property this material will compute");
26  params.addRequiredCoupledVar(
27  "variable",
28  "The name of the variable whose value is used as the abscissa in the interpolation");
29  params.addParam<std::vector<Real>>("x", "The abscissa values");
30  params.addParam<std::vector<Real>>("y", "The ordinate values");
31  params.addParam<std::vector<Real>>("xy_data",
32  "All function data, supplied in abscissa, ordinate pairs");
33  params.addParam<Real>("scale_factor", 1.0, "Scale factor to be applied to the ordinate values");
34  return params;
35 }
36 
38  const InputParameters & parameters)
40  _prop_name(getParam<std::string>("property")),
41  _coupled_var(coupledValue("variable")),
42  _scale_factor(getParam<Real>("scale_factor")),
43  _property(declareProperty<Real>(_prop_name)),
44  _dproperty(declarePropertyDerivative<Real>(_prop_name, getVar("variable", 0)->name()))
45 {
46  std::vector<Real> x;
47  std::vector<Real> y;
48 
49  if ((parameters.isParamValid("x")) || (parameters.isParamValid("y")))
50  {
51  if (!((parameters.isParamValid("x")) && (parameters.isParamValid("y"))))
52  mooseError("In PiecewiseLinearInterpolationMaterial ",
53  _name,
54  ": Both 'x' and 'y' must be specified if either one is specified.");
55 
56  if (parameters.isParamValid("xy_data"))
57  mooseError("In PiecewiseLinearInterpolationMaterial ",
58  _name,
59  ": Cannot specify 'x', 'y', and 'xy_data' together.");
60 
61  x = getParam<std::vector<Real>>("x");
62  y = getParam<std::vector<Real>>("y");
63  }
64  else if (parameters.isParamValid("xy_data"))
65  {
66  std::vector<Real> xy = getParam<std::vector<Real>>("xy_data");
67  unsigned int xy_size = xy.size();
68  if (xy_size % 2 != 0)
69  mooseError("In PiecewiseLinearInterpolationMaterial ",
70  _name,
71  ": Length of data provided in 'xy_data' must be a multiple of 2.");
72 
73  unsigned int x_size = xy_size / 2;
74  x.reserve(x_size);
75  y.reserve(x_size);
76  for (unsigned int i = 0; i < xy_size / 2; ++i)
77  {
78  x.push_back(xy[i * 2]);
79  y.push_back(xy[i * 2 + 1]);
80  }
81  }
82 
83  try
84  {
85  _linear_interp = libmesh_make_unique<LinearInterpolation>(x, y);
86  }
87  catch (std::domain_error & e)
88  {
89  mooseError("In PiecewiseLinearInterpolationMaterial ", _name, ": ", e.what());
90  }
91 }
92 
93 void
95 {
97  _dproperty[_qp] = _scale_factor * _linear_interp->sampleDerivative(_coupled_var[_qp]);
98 }
PiecewiseLinearInterpolationMaterial(const InputParameters &parameters)
const VariableValue & _coupled_var
Value of the coupled variable to be used as the abscissa in the piecewise linear interpolation.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< PiecewiseLinearInterpolationMaterial >()
void mooseError(Args &&... args) const
Definition: MooseObject.h:147
static PetscErrorCode Vec x
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
unsigned int _qp
Definition: Material.h:222
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:65
std::unique_ptr< LinearInterpolation > _linear_interp
LinearInterpolation object.
Materials compute MaterialProperties.
Definition: Material.h:46
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
const std::string & _name
The name of this object, reference to value stored in InputParameters.
Definition: MooseObject.h:183
This material uses a LinearInterpolation object to define the dependence of the material&#39;s value on a...
Interface class ("Veneer") to provide generator methods for derivative material property names...
MaterialProperty< Real > & _property
Material property to be calculated.
registerMooseObject("MooseApp", PiecewiseLinearInterpolationMaterial)
virtual void computeQpProperties() override
Users must override this method.
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
MaterialProperty< Real > & _dproperty
First derivative of the material property wrt the coupled variable.
InputParameters validParams< Material >()
Definition: Material.C:22
const Real _scale_factor
Factor to scale the ordinate values by (default = 1)
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another, i.e.