TransientInterface.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 "Moose.h"
#include "MooseFunctorArguments.h"

#define usingTransientInterfaceMembers                                                             \
  using TransientInterface::_t;                                                                    \
  using TransientInterface::_t_step;                                                               \
  using TransientInterface::_dt;                                                                   \
  using TransientInterface::_dt_old

// Forward declarations
class FEProblemBase;
class InputParameters;
class MooseObject;
template <typename T>
InputParameters validParams();

class TransientInterface
{
public:
  TransientInterface(const MooseObject * moose_object);

#ifdef MOOSE_KOKKOS_ENABLED

  TransientInterface(const TransientInterface & object, const Moose::Kokkos::FunctorCopy & key);
#endif

  virtual ~TransientInterface();

  static InputParameters validParams();

  bool isImplicit() { return _is_implicit; }

  Moose::StateArg determineState() const;

protected:
  const InputParameters & _ti_params;

  FEProblemBase & _ti_feproblem;

  bool _is_implicit;

  Real & _t;

  const Real & _t_old;

  int & _t_step;

  Real & _dt;

  Real & _dt_old;

  // NOTE: dunno if it is set properly in time of instantiation (might be a source of bugs)
  bool _is_transient;

private:
  const std::string _ti_name;
};

inline Moose::StateArg
TransientInterface::determineState() const
{
  return _is_implicit ? Moose::currentState() : Moose::oldState();
}