SolutionFunction.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 "Function.h"
#include "SolutionUserObjectBase.h"
#include <optional>
 
class SolutionFunction : public Function
{
public:
  static InputParameters validParams();
 
  SolutionFunction(const InputParameters & parameters);
 
  using Function::value;
  virtual Real value(Real t, const Point & p) const override;
 
  virtual RealGradient gradient(Real t, const Point & p) const override;
 
  virtual void initialSetup() override;
 
protected:
  const SolutionUserObjectBase * _solution_object_ptr;
 
  std::string _solution_object_var_name;
 
  const std::optional<SolutionUserObjectBase::WeightingType> _weighting_type;
 
  const Real _scale_factor;
 
  const Real _add_factor;
 
  RealGradient _add_grad;
};