FlowModel.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 "InputParameters.h"
#include "NamingInterface.h"
#include "THMEnums.h"
#include "libmesh/fe_type.h"

class THMProblem;
class Factory;
class ThermalHydraulicsApp;
class FluidProperties;
class FlowChannelBase;

class FlowModel : public MooseObject, public NamingInterface
{
public:
  FlowModel(const InputParameters & params);

  virtual void init() {}

  virtual void addVariables() = 0;

  virtual void addInitialConditions() = 0;

  virtual void addMooseObjects() = 0;

protected:
  THMProblem & _sim;

  Factory & _factory;

  FlowChannelBase & _flow_channel;

  const libMesh::FEType & _fe_type;

  const UserObjectName _fp_name;

  const std::string _comp_name;

  const RealVectorValue & _gravity_vector;
  const Real _gravity_magnitude;

  // Solution variable names
  std::vector<VariableName> _solution_vars;

  // Names of variables for which derivative material properties need to be created
  std::vector<VariableName> _derivative_vars;

  const bool & _output_vector_velocity;

  const FunctionName & getVariableFn(const FunctionName & fn_param_name);

  virtual void addCommonVariables();

  virtual void addCommonInitialConditions();

  virtual void addCommonMooseObjects();

public:
  static const std::string AREA;
  static const std::string AREA_LINEAR;
  static const std::string HEAT_FLUX_WALL;
  static const std::string HEAT_FLUX_PERIMETER;
  static const std::string NUSSELT_NUMBER;
  static const std::string SURFACE_TENSION;
  static const std::string TEMPERATURE_WALL;
  static const std::string UNITY;
  static const std::string DIRECTION;

  static InputParameters validParams();
};