MooseParsedFunctionWrapper.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "MooseError.h"
#include "MooseTypes.h"

#include "libmesh/parsed_function.h"

// C++ includes
#include <string>
#include <vector>

// Forward declarations
class FEProblemBase;
class Function;

class MooseParsedFunctionWrapper
{
public:
  MooseParsedFunctionWrapper(FEProblemBase & feproblem,
                             const std::string & function_str,
                             const std::vector<std::string> & vars,
                             const std::vector<std::string> & vals,
                             const THREAD_ID tid = 0);

  virtual ~MooseParsedFunctionWrapper();

  template <typename T>
  T evaluate(Real t, const Point & p);

  RealGradient evaluateGradient(Real t, const Point & p);

  Real evaluateDot(Real t, const Point & p);

private:
  FEProblemBase & _feproblem;

  const std::string & _function_str;

  const std::vector<std::string> & _vars;

  const std::vector<std::string> & _vals_input;

  std::vector<Real> _initial_vals;

  std::unique_ptr<ParsedFunction<Real>> _function_ptr;

  std::vector<unsigned int> _pp_index;

  std::vector<const Real *> _pp_vals;

  std::vector<unsigned int> _scalar_index;

  std::vector<const Real *> _scalar_vals;

  std::vector<unsigned int> _function_index;

  std::vector<const Function *> _functions;

  std::vector<Real *> _addr;

  const THREAD_ID _tid;

  void initialize();

  void update();

  void updateFunctionValues(Real t, const Point & pt);

  // moose_unit needs access
  friend class ParsedFunctionTest;
};

template <typename T>
T
evaluate(Real /*t*/, const Point & /*p*/)
{
  mooseError("The evaluate method is not defined for this type.");
}

template <>
Real MooseParsedFunctionWrapper::evaluate(Real t, const Point & p);

template <>
DenseVector<Real> MooseParsedFunctionWrapper::evaluate(Real t, const Point & p);

template <>
RealVectorValue MooseParsedFunctionWrapper::evaluate(Real t, const Point & p);