INSFVVariable.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 "MooseVariableFV.h"

class InputParameters;
class INSFVHydraulicSeparatorInterface;

class INSFVVariable : public MooseVariableFVReal
{
public:
  INSFVVariable(const InputParameters & params);

  static InputParameters validParams();

  // The INSFV system relies on on-the-fly functor evaluation and does not need any pre-init'd data
  void computeFaceValues(const FaceInfo &) override;
  void computeElemValues() override;
  void computeElemValuesFace() override;
  void computeNeighborValuesFace() override;
  void computeNeighborValues() override;
  void requireQpComputations() const override { _qp_calculations = true; }
  bool supportsQpBasedLoops() const override { return _qp_calculations; }
  bool supportsGeometricInfoBasedLoops() const override { return true; }
  virtual void initialSetup() override;
  virtual void timestepSetup() override;
  virtual void meshChanged() override;

  // If the given boundary is a hydraulic separator bouundary for this variable
  bool isSeparatorBoundary(const FaceInfo & fi) const;

  bool isExtrapolatedBoundaryFace(const FaceInfo & fi,
                                  const Elem * elem,
                                  const Moose::StateArg & time) const override;

protected:
  bool isFullyDevelopedFlowFace(const FaceInfo & fi) const;

  void cacheSeparatorBoundaries();

  std::unordered_map<BoundaryID, const INSFVHydraulicSeparatorInterface *>
      _boundary_id_to_separator;

private:
  mutable bool _qp_calculations;
};

inline void
INSFVVariable::computeFaceValues(const FaceInfo & fi)
{
  if (_qp_calculations)
    MooseVariableFVReal::computeFaceValues(fi);
}

inline void
INSFVVariable::computeElemValues()
{
  if (_qp_calculations)
    MooseVariableFVReal::computeElemValues();
  else
    _element_data->setGeometry(Moose::Volume);
}

inline void
INSFVVariable::computeElemValuesFace()
{
  if (_qp_calculations)
    MooseVariableFVReal::computeElemValuesFace();
}

inline void
INSFVVariable::computeNeighborValuesFace()
{
  if (_qp_calculations)
    MooseVariableFVReal::computeNeighborValuesFace();
}

inline void
INSFVVariable::computeNeighborValues()
{
  if (_qp_calculations)
    MooseVariableFVReal::computeNeighborValues();
}