RichardsVarNames.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"

class RichardsVarNames : public GeneralUserObject, public Coupleable
{
public:
  static InputParameters validParams();

  RichardsVarNames(const InputParameters & parameters);

  void initialize();
  void execute();
  void finalize();

  unsigned int num_v() const;

  unsigned int richards_var_num(unsigned int moose_var_num) const;

  bool not_richards_var(unsigned int moose_var_num) const;

  std::string richards_names() const;

  const VariableValue * richards_vals(unsigned int richards_var_num) const;

  const VariableValue * richards_vals_old(unsigned int richards_var_num) const;

  const VariableGradient * grad_var(unsigned int richards_var_num) const;

  const VariableValue * nodal_var(unsigned int richards_var_num) const;

  const VariableValue * nodal_var_old(unsigned int richards_var_num) const;

  std::string var_types() const;

protected:
  unsigned int _num_v;

  MooseEnum _var_types;

  const std::vector<unsigned int> _moose_var_num;

  std::vector<unsigned int> _ps_var_num;

  const std::vector<const VariableValue *>
      _moose_var_value; // this is a vector of pointers to VariableValues

  const std::vector<const VariableValue *> _moose_var_value_old;

  std::vector<const VariableValue *>
      _moose_nodal_var_value; // this is a vector of pointers to VariableValues

  std::vector<const VariableValue *> _moose_nodal_var_value_old;

  const std::vector<const VariableGradient *> _moose_grad_var;
};