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

// MOOSE includes
#include "MooseUtils.h"
#include "ParallelParamObject.h"
#include "InputParameters.h"
#include "ConsoleStreamInterface.h"
#include "Registry.h"
#include "MooseObjectParameterName.h"
#include "SolutionInvalidInterface.h"

#define usingMooseObjectMembers                                                                    \
  usingMooseBaseMembers;                                                                           \
  using MooseObject::enabled

class MooseObject : public ParallelParamObject,
                    public SolutionInvalidInterface,
                    public std::enable_shared_from_this<MooseObject>
{
public:
  static InputParameters validParams();

  MooseObject(const InputParameters & parameters);

#ifdef MOOSE_KOKKOS_ENABLED

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

  virtual ~MooseObject() = default;

  virtual bool enabled() const { return _enabled; }

  std::shared_ptr<MooseObject> getSharedPtr();
  std::shared_ptr<const MooseObject> getSharedPtr() const;

#ifdef MOOSE_KOKKOS_ENABLED
  class IsKokkosObjectKey
  {
    friend class BlockRestrictable;
    friend class BoundaryRestrictable;
    friend class MaterialPropertyInterface;
    IsKokkosObjectKey() = default;
    IsKokkosObjectKey(const IsKokkosObjectKey &) = delete;
    IsKokkosObjectKey(IsKokkosObjectKey &&) = delete;
  };

  bool isKokkosObject(IsKokkosObjectKey &&) const
  {
    return parameters().isParamValid(MooseBase::kokkos_object_param);
  }
#endif

  // To get warnings tracked in the SolutionInvalidityOutput
  usingCombinedWarningSolutionWarnings;

protected:
  const bool & _enabled;

  // Base classes have the same name for that attribute, pick one
  using MooseBase::_app;
};