MooseVariableBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "MooseTypes.h"
#include "MooseArray.h"

#include "libmesh/fe_type.h"

// libMesh forward declarations
namespace libMesh
{
class DofMap;
class Variable;
}

class SubProblem;
class SystemBase;
class MooseMesh;

class MooseVariableBase
{
public:
  MooseVariableBase(unsigned int var_num,
                    const FEType & fe_type,
                    SystemBase & sys,
                    Moose::VarKindType var_kind,
                    THREAD_ID tid);
  virtual ~MooseVariableBase();

  unsigned int number() const { return _var_num; }

  const FEType & feType() const { return _fe_type; }

  SystemBase & sys() { return _sys; }

  const std::string & name() const;

  const std::vector<dof_id_type> & allDofIndices() const;
  unsigned int totalVarDofs() { return allDofIndices().size(); }

  Moose::VarKindType kind() const { return _var_kind; }

  void scalingFactor(Real factor) { _scaling_factor = factor; }

  Real scalingFactor() const { return _scaling_factor; }

  Order order() const;

  const DofMap & dofMap() const { return _dof_map; }

  virtual const std::vector<dof_id_type> & dofIndices() const { return _dof_indices; }

  virtual unsigned int numberOfDofs() const { return _dof_indices.size(); }

protected:
  unsigned int _var_num;
  FEType _fe_type;
  unsigned int _index;
  Moose::VarKindType _var_kind;
  SubProblem & _subproblem;
  SystemBase & _sys;

  const Variable & _variable;

  const DofMap & _dof_map;
  std::vector<dof_id_type> _dof_indices;

  MooseMesh & _mesh;

  Real _scaling_factor;

  THREAD_ID _tid;
};