MooseVariableInterface.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

#include "MooseVariableBase.h"

// Forward declarations
class Assembly;
class MooseObject;
template <typename T>
class MooseVariableField;
template <typename T>
class MooseVariableFE;
template <typename T>
class MooseVariableFV;
template <typename T>
class MooseLinearVariableFV;

template <typename T>
class MooseVariableInterface
{
public:
  MooseVariableInterface(
      const MooseObject * moose_object,
      bool nodal,
      std::string var_param_name = "variable",
      Moose::VarKindType expected_var_type = Moose::VarKindType::VAR_ANY,
      Moose::VarFieldType expected_var_field_type = Moose::VarFieldType::VAR_FIELD_ANY);

  MooseVariableBase * mooseVariableBase() const { return _var; };

  MooseVariableField<T> & mooseVariableField();

  MooseVariableFE<T> * mooseVariable() const;

  MooseVariableFV<T> * mooseVariableFV() const;

  MooseLinearVariableFV<T> * mooseLinearVariableFV() const;

  virtual ~MooseVariableInterface();

protected:
  virtual const typename OutputTools<T>::VariableValue & value();

  virtual const typename OutputTools<T>::VariableValue & valueOld();

  virtual const typename OutputTools<T>::VariableValue & valueOlder();

  virtual const typename OutputTools<T>::VariableValue & dot();

  virtual const typename OutputTools<T>::VariableValue & dotDot();

  virtual const typename OutputTools<T>::VariableValue & dotOld();

  virtual const typename OutputTools<T>::VariableValue & dotDotOld();

  virtual const VariableValue & dotDu();

  virtual const VariableValue & dotDotDu();

  virtual const typename OutputTools<T>::VariableGradient & gradient();

  virtual const typename OutputTools<T>::VariableGradient & gradientOld();

  virtual const typename OutputTools<T>::VariableGradient & gradientOlder();

  virtual const typename OutputTools<T>::VariableSecond & second();

  virtual const typename OutputTools<T>::VariableSecond & secondOld();

  virtual const typename OutputTools<T>::VariableSecond & secondOlder();

  virtual const typename OutputTools<T>::VariableTestSecond & secondTest();

  virtual const typename OutputTools<T>::VariableTestSecond & secondTestFace();

  virtual const typename OutputTools<T>::VariablePhiSecond & secondPhi();

  virtual const typename OutputTools<T>::VariablePhiSecond & secondPhiFace();

  bool _nodal;

  MooseVariableBase * _var = nullptr;
  MooseVariableFE<T> * _variable = nullptr;
  MooseVariableFV<T> * _fv_variable = nullptr;
  MooseLinearVariableFV<T> * _linear_fv_variable = nullptr;
  MooseVariableField<T> * _field_variable = nullptr;

protected:
  Assembly * _mvi_assembly;

private:
  const MooseObject & _moose_object;
};