19 "File holding data for use with PiecewiseMultiInterpolation. Format: any empty line and any " 21 "beginning with # are ignored, all other lines are assumed to contain relevant information. " 22 "The file must begin with specification of the grid. This is done through lines containing " 23 "the keywords: AXIS X; AXIS Y; AXIS Z; or AXIS T. Immediately following the keyword line " 24 "must be a space-separated line of real numbers which define the grid along the specified " 25 "axis. These data must be monotonically increasing. After all the axes and their grids " 26 "have been specified, there must be a line that is DATA. Following that line, function " 27 "values are given in the correct order (they may be on individual lines, or be " 28 "space-separated on a number of lines). When the function is evaluated, f[i,j,k,l] " 29 "corresponds to the i + j*Ni + k*Ni*Nj + l*Ni*Nj*Nk data value. Here i>=0 corresponding to " 30 "the index along the first AXIS, j>=0 corresponding to the index along the second AXIS, etc, " 31 "and Ni = number of grid points along the first AXIS, etc.");
37 _gridded_data(
std::make_unique<
GriddedData>(getParam<FileName>(
"data_file"))),
38 _dim(_gridded_data->getDim())
44 for (
unsigned int i = 0; i <
_dim; ++i)
45 for (
unsigned int j = 1; j <
_grid[i].size(); ++j)
47 mooseError(
"PiecewiseMultiInterpolation needs monotonically-increasing axis data. Axis ",
49 " contains non-monotonicity at value ",
56 "PiecewiseMultiInterpolation needs the AXES to be independent. Check the AXIS lines in " 69 for (
unsigned int i = 0; i <
_dim; ++i)
72 point_in_grid[i] = p(
_axes[i]);
73 else if (
_axes[i] == 3)
80 PiecewiseMultiInterpolation::pointInGrid<false>(
const Real &,
const Point &)
const;
82 PiecewiseMultiInterpolation::pointInGrid<true>(
const ADReal &,
const ADPoint &)
const;
87 return sample(pointInGrid<false>(t, p));
93 return sample(pointInGrid<true>(t, p));
99 mooseError(
"The AD variant of 'sample' needs to be implemented");
105 unsigned int & lower_x,
106 unsigned int & upper_x)
const 108 int N = in_arr.size();
114 else if (x >= in_arr[
N - 1])
122 std::vector<double>::iterator up = std::lower_bound(in_arr.begin(), in_arr.end(), x);
127 upper_x =
static_cast<unsigned int>(std::distance(in_arr.begin(), up));
128 if (in_arr[upper_x] == x)
131 lower_x = upper_x - 1;
Container for holding a function defined on a grid of arbitrary dimension.
Base class for function objects.
static InputParameters validParams()
Create new PiecewiseMultiInterpolation object.
std::unique_ptr< GriddedData > _gridded_data
object to provide function evaluations at points on the grid
std::vector< std::vector< Real > > _grid
the grid
Utility class template for a semidynamic vector with a maximum size N and a chosen dynamic size...
void getNeighborIndices(std::vector< Real > in_arr, Real x, unsigned int &lower_x, unsigned int &upper_x) const
Operates on monotonically increasing in_arr.
std::vector< int > _axes
_axes specifies how to embed the grid into the MOOSE coordinate frame if _axes[i] = 0 then the i_th a...
virtual ~PiecewiseMultiInterpolation()
unsigned int _dim
dimension of the grid
MooseADWrapper< GridPoint, is_ad > pointInGrid(const MooseADWrapper< Real, is_ad > &t, const MooseADWrapper< Point, is_ad > &p) const
convert cartesian+time coordinates into grid coordinates
typename MooseADWrapperStruct< T, is_ad >::type MooseADWrapper
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
PiecewiseMultiInterpolation(const InputParameters ¶meters)
void mooseError(Args &&... args) const
Emits an error prefixed with object name and type.
virtual Real value(Real t, const Point &pt) const override
Given t and p, return the interpolated value.
virtual Real sample(const GridPoint &pt) const =0
This does the core work.
static InputParameters validParams()
Class constructor.