FlowModelSetup.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 "ActionFactory.h"
#include "ActionWarehouse.h"
#include "InputParameters.h"
#include "MooseApp.h"
#include "MooseTypes.h"

class FlowModelSetup
{
public:
  FlowModelSetup(const InputParameters & params);

protected:
  virtual void addInitialConditions() = 0;
  virtual void addSolutionVariables() = 0;
  virtual void addNonConstantAuxVariables() = 0;
  virtual void addMaterials();
  virtual void addUserObjects() = 0;

  void addSolutionVariable(const VariableName & var_name, const Real & scaling = 1.0);

  void addAuxVariable(const VariableName & var_name);

  void addFunctionIC(const VariableName & var_name, const FunctionName & function_name);

  template <typename T>
  const T & getParam(const std::string & name) const;

  const InputParameters & _this_params;
  MooseApp & _this_app;
  ActionFactory & _this_action_factory;
  ActionWarehouse & _this_action_warehouse;

  MooseEnum _fe_family;
  MooseEnum _fe_order;

  const Real & _gravity_magnitude;

public:
  static InputParameters validParams();
};

template <typename T>
const T &
FlowModelSetup::getParam(const std::string & name) const
{
  return InputParameters::getParamHelper(name, _this_params, static_cast<T *>(0));
}