InitialConditionBase.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 "InitialConditionInterface.h"
#include "MooseObject.h"
#include "Coupleable.h"
#include "FunctionInterface.h"
#include "UserObjectInterface.h"
#include "PostprocessorInterface.h"
#include "Restartable.h"
#include "BlockRestrictable.h"
#include "DependencyResolverInterface.h"
#include "BoundaryRestrictable.h"
#include "MaterialPropertyInterface.h"
#include "MooseTypes.h"
#include "ElementIDInterface.h"
 
class SystemBase;
class MooseVariableFieldBase;
namespace libMesh
{
class Point;
}
 
class InitialConditionBase : public MooseObject,
                             public InitialConditionInterface,
                             public BlockRestrictable,
                             public Coupleable,
                             public MaterialPropertyInterface,
                             public FunctionInterface,
                             public UserObjectInterface,
                             public PostprocessorInterface,
                             public BoundaryRestrictable,
                             public DependencyResolverInterface,
                             public Restartable,
                             public ElementIDInterface
{
public:
  InitialConditionBase(const InputParameters & parameters);
 
  virtual ~InitialConditionBase();
 
  static InputParameters validParams();
 
  virtual MooseVariableFEBase & variable() = 0;
 
  const std::set<UserObjectName> & getDependObjects() const { return _depend_uo; }
 
  virtual void compute() = 0;
  virtual void computeNodal(const Point & p) = 0;
 
  virtual void initialSetup() {}
 
  virtual const std::set<std::string> & getRequestedItems() override;
 
  virtual const std::set<std::string> & getSuppliedItems() override;
 
protected:
  SystemBase & _sys;
 
  const bool _ignore_uo_dependency;
 
private:
  void addUserObjectDependencyHelper(const UserObjectBase & uo) const override final;
  void addPostprocessorDependencyHelper(const PostprocessorName & name) const override final;
 
  std::set<std::string> _depend_vars;
  std::set<std::string> _supplied_vars;
 
  mutable std::set<UserObjectName> _depend_uo;
};