MaterialAuxBase.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 "AuxKernel.h"

// Forward declarations
template <typename T = Real>
class MaterialAuxBase;

template <>
InputParameters validParams<MaterialAuxBase<>>();

template <typename T>
class MaterialAuxBase : public AuxKernel
{
public:
  MaterialAuxBase(const InputParameters & parameters);

protected:
  virtual Real computeValue() override;

  virtual Real getRealValue() = 0;

  const MaterialProperty<T> & _prop;

private:
  const Real _factor;

  const Real _offset;
};

template <typename T>
MaterialAuxBase<T>::MaterialAuxBase(const InputParameters & parameters)
  : AuxKernel(parameters),
    _prop(getMaterialProperty<T>("property")),
    _factor(getParam<Real>("factor")),
    _offset(getParam<Real>("offset"))
{
}

template <typename T>
Real
MaterialAuxBase<T>::computeValue()
{
  return _factor * getRealValue() + _offset;
}