PorousFlowDictator.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 "GeneralUserObject.h"
#include "Coupleable.h"
 
#include <optional>
#include <set>
 
class PorousFlowDictator : public GeneralUserObject, public Coupleable
{
public:
  static InputParameters validParams();
 
  PorousFlowDictator(const InputParameters & parameters);
 
  virtual void initialize() override {};
  virtual void execute() override {};
  virtual void finalize() override {};
 
  unsigned int numVariables() const;
 
  unsigned int numPhases() const;
 
  unsigned int numComponents() const;
 
  unsigned int numAqueousEquilibrium() const;
 
  unsigned int numAqueousKinetic() const;
 
  unsigned int aqueousPhaseNumber() const;
 
  unsigned int porousFlowVariableNum(unsigned int moose_var_num) const;
 
  unsigned int mooseVariableNum(unsigned int porous_flow_var_num) const;
 
  bool isPorousFlowVariable(unsigned int moose_var_num) const;
 
  bool notPorousFlowVariable(unsigned int moose_var_num) const;
 
  bool consistentFEType() const;
 
  libMesh::FEType feType() const;
 
  bool isFV() const;
 
  bool usePermDerivs() const { return _perm_derivs; };
 
  void usePermDerivs(bool flag) const { _perm_derivs = flag; };
 
  void registerNodalVariable(const VariableName & var_name) const;
 
  static std::string feTypeName(const libMesh::FEType & fe_type);
 
  const std::optional<libMesh::FEType> & shareNodalVariableFEType() const { return _nodal_fe_type; }
 
protected:
  const unsigned int _num_variables;
 
  const unsigned int _num_phases;
 
  const unsigned int _num_components;
 
  const unsigned int _num_aqueous_equilibrium;
 
  const unsigned int _num_aqueous_kinetic;
 
  const unsigned int _aqueous_phase_number;
 
  mutable bool _perm_derivs;
 
private:
  mutable std::optional<libMesh::FEType> _nodal_fe_type;
 
  mutable std::set<VariableName> _nodal_fe_type_vars;
 
  bool _consistent_fe_type;
 
  libMesh::FEType _fe_type;
 
  bool _is_fv;
 
  std::vector<unsigned int> _moose_var_num;
 
  std::vector<unsigned int> _pf_var_num;
};