Marker.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 "MooseObject.h"
#include "BlockRestrictable.h"
#include "SetupInterface.h"
#include "DependencyResolverInterface.h"
#include "MooseVariableDependencyInterface.h"
#include "UserObjectInterface.h"
#include "Restartable.h"
#include "PostprocessorInterface.h"
#include "MeshChangedInterface.h"
#include "OutputInterface.h"

// Forward declarations
class MooseMesh;
class SubProblem;
class FEProblemBase;
class SystemBase;
class Assembly;
template <typename>
class MooseVariableFE;
typedef MooseVariableFE<Real> MooseVariable;
typedef MooseVariableFE<VectorValue<Real>> VectorMooseVariable;
class Adaptivity;

namespace libMesh
{
class ErrorVector;
}
using libMesh::ErrorVector;

class Marker : public MooseObject,
               public BlockRestrictable,
               public SetupInterface,
               public DependencyResolverInterface,
               public MooseVariableDependencyInterface,
               public UserObjectInterface,
               public Restartable,
               public PostprocessorInterface,
               public MeshChangedInterface,
               public OutputInterface
{
public:
  static InputParameters validParams();

  Marker(const InputParameters & parameters);
  virtual ~Marker() {}

  enum MarkerValue
  {
    DONT_MARK = -1,
    COARSEN,
    DO_NOTHING,
    REFINE
  };

  static MooseEnum markerStates();

  virtual void computeMarker();

  bool isActive() const;

  virtual void markerSetup();

  virtual const std::set<std::string> & getRequestedItems() override;

  virtual const std::set<std::string> & getSuppliedItems() override;

protected:
  virtual MarkerValue computeElementMarker() = 0;

  ErrorVector & getErrorVector(std::string indicator);

  const MooseArray<Real> & getMarkerValue(std::string name);

  SubProblem & _subproblem;
  FEProblemBase & _fe_problem;
  Adaptivity & _adaptivity;
  SystemBase & _sys;

  THREAD_ID _tid;

  Assembly & _assembly;

  MooseVariable & _field_var;
  const Elem * const & _current_elem;

  MooseMesh & _mesh;

  std::set<std::string> _depend;
  std::set<std::string> _supplied;
};