BoundaryFluxBase.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 "ThreadedGeneralUserObject.h"

class BoundaryFluxBase : public ThreadedGeneralUserObject
{
public:
  static InputParameters validParams();

  BoundaryFluxBase(const InputParameters & parameters);

  virtual void execute() override {}
  virtual void initialize() override;
  virtual void finalize() override {}
  virtual void threadJoin(const UserObject &) override {}

  virtual const std::vector<Real> & getFlux(unsigned int iside,
                                            dof_id_type ielem,
                                            const std::vector<Real> & uvec1,
                                            const RealVectorValue & dwave) const;

  virtual void calcFlux(unsigned int iside,
                        dof_id_type ielem,
                        const std::vector<Real> & uvec1,
                        const RealVectorValue & dwave,
                        std::vector<Real> & flux) const = 0;

  virtual const DenseMatrix<Real> & getJacobian(unsigned int iside,
                                                dof_id_type ielem,
                                                const std::vector<Real> & uvec1,
                                                const RealVectorValue & dwave) const;

  virtual void calcJacobian(unsigned int iside,
                            dof_id_type ielem,
                            const std::vector<Real> & uvec1,
                            const RealVectorValue & dwave,
                            DenseMatrix<Real> & jac1) const = 0;

protected:
  mutable unsigned int _cached_flux_elem_id;
  mutable unsigned int _cached_flux_side_id;

  mutable unsigned int _cached_jacobian_elem_id;
  mutable unsigned int _cached_jacobian_side_id;

  mutable std::vector<Real> _flux;

  mutable DenseMatrix<Real> _jac1;
};