MooseVariableFieldBase.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 "MooseVariableBase.h"

namespace libMesh
{
template <typename>
class DenseVector;
template <typename>
class NumericVector;
class Point;
}

class FaceInfo;

class MooseVariableFieldBase : public MooseVariableBase
{
public:
  static InputParameters validParams();

  MooseVariableFieldBase(const InputParameters & parameters);

  virtual void clearDofIndices() = 0;

  virtual void prepare() = 0;

  virtual void prepareNeighbor() = 0;

  virtual void prepareLowerD() = 0;

  virtual void prepareAux() = 0;

  virtual void reinitNode() = 0;
  virtual void reinitAux() = 0;
  virtual void reinitAuxNeighbor() = 0;

  virtual void reinitNodes(const std::vector<dof_id_type> & nodes) = 0;
  virtual void reinitNodesNeighbor(const std::vector<dof_id_type> & nodes) = 0;

  virtual Moose::VarFieldType fieldType() const = 0;

  virtual bool isArray() const = 0;

  std::string componentName(const unsigned int comp) const;

  virtual bool isVector() const = 0;

  virtual bool isFV() const { return false; }

  virtual bool isNodalDefined() const = 0;

  virtual const dof_id_type & nodalDofIndex() const = 0;
  virtual const dof_id_type & nodalDofIndexNeighbor() const = 0;

  virtual const Elem * const & currentElem() const = 0;

  const std::set<SubdomainID> & activeSubdomains() const;

  bool activeOnSubdomain(SubdomainID subdomain) const;

  bool activeOnSubdomains(const std::set<SubdomainID> & subdomains) const;

  virtual bool needsGradientVectorStorage() const { return false; }

  virtual void prepareIC() = 0;

  virtual void computeFaceValues(const FaceInfo & /*fi*/) { mooseError("not implemented"); }

  virtual void computeElemValues() = 0;
  virtual void computeElemValuesFace() = 0;
  virtual void computeNeighborValuesFace() = 0;
  virtual void computeNeighborValues() = 0;
  virtual void computeLowerDValues() = 0;
  virtual void computeNodalNeighborValues() = 0;
  virtual void computeNodalValues() = 0;

  virtual const std::vector<dof_id_type> & dofIndicesNeighbor() const = 0;

  virtual const std::vector<dof_id_type> & dofIndicesLower() const = 0;

  virtual unsigned int numberOfDofsNeighbor() = 0;

  virtual void insert(libMesh::NumericVector<libMesh::Number> & vector) = 0;

  virtual void insertLower(libMesh::NumericVector<libMesh::Number> & vector) = 0;

  virtual void add(libMesh::NumericVector<libMesh::Number> & vector) = 0;

  virtual std::size_t phiSize() const = 0;
  virtual std::size_t phiFaceSize() const = 0;
  virtual std::size_t phiNeighborSize() const = 0;
  virtual std::size_t phiFaceNeighborSize() const = 0;
  virtual std::size_t phiLowerSize() const = 0;

  virtual unsigned int oldestSolutionStateRequested() const = 0;
};

#define usingMooseVariableFieldBaseMembers usingMooseVariableBaseMembers