KokkosLinearFVAdvection.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 "KokkosLinearFVFluxKernel.h"

class KokkosLinearFVAdvection : public Moose::Kokkos::LinearFVFluxKernel
{
public:
  static InputParameters validParams();

  KokkosLinearFVAdvection(const InputParameters & parameters);

  virtual bool needsBoundaryValueData() const override { return true; }
  virtual bool hasInternalRightHandSideContribution() const override { return false; }

  template <typename Derived>
  KOKKOS_FUNCTION Real computeInternalMatrixContribution(const FVDatum & datum) const;
  template <typename Derived>
  KOKKOS_FUNCTION Real computeInternalNeighborMatrixContribution(const FVDatum & datum) const;
  template <typename Derived>
  KOKKOS_FUNCTION Real computeBoundaryMatrixContribution(
      const FVDatum & datum, const int bc_index, const MOOSE_KOKKOS_INDEX_TYPE bc_face_index) const;
  template <typename Derived>
  KOKKOS_FUNCTION Real computeBoundaryRightHandSideContribution(
      const FVDatum & datum, const int bc_index, const MOOSE_KOKKOS_INDEX_TYPE bc_face_index) const;

private:
  KOKKOS_FUNCTION Real normalFaceFlux(const FVDatum & datum) const;

  const Moose::Kokkos::Real3 _velocity;
};

template <typename Derived>
KOKKOS_FUNCTION Real
KokkosLinearFVAdvection::computeInternalMatrixContribution(const FVDatum & datum) const
{
  const auto face_flux = normalFaceFlux(datum);
  return face_flux > 0 ? face_flux * datum.faceArea() : 0;
}

template <typename Derived>
KOKKOS_FUNCTION Real
KokkosLinearFVAdvection::computeInternalNeighborMatrixContribution(const FVDatum & datum) const
{
  const auto face_flux = normalFaceFlux(datum);
  return face_flux < 0 ? face_flux * datum.faceArea() : 0;
}

template <typename Derived>
KOKKOS_FUNCTION Real
KokkosLinearFVAdvection::computeBoundaryMatrixContribution(
    const FVDatum & datum, const int bc_index, const MOOSE_KOKKOS_INDEX_TYPE bc_face_index) const
{
  return normalFaceFlux(datum) * datum.faceArea() *
         boundaryValueCoefficient(bc_index, bc_face_index);
}

template <typename Derived>
KOKKOS_FUNCTION Real
KokkosLinearFVAdvection::computeBoundaryRightHandSideContribution(
    const FVDatum & datum, const int bc_index, const MOOSE_KOKKOS_INDEX_TYPE bc_face_index) const
{
  return -normalFaceFlux(datum) * datum.faceArea() * boundaryValueSource(bc_index, bc_face_index);
}

KOKKOS_FUNCTION inline Real
KokkosLinearFVAdvection::normalFaceFlux(const FVDatum & datum) const
{
  return _velocity * datum.faceNormal();
}