Free outflow BC based boundary flux user object for the advection equation using a cell-centered finite volume method. More...

#include <AEFVFreeOutflowBoundaryFlux.h>

Inheritance diagram for AEFVFreeOutflowBoundaryFlux:

[legend]

Public Member Functions
	AEFVFreeOutflowBoundaryFlux (const InputParameters &parameters)

virtual	~AEFVFreeOutflowBoundaryFlux ()

virtual void	calcFlux (unsigned int iside, dof_id_type ielem, const std::vector< Real > &uvec1, const RealVectorValue &dwave, std::vector< Real > &flux) const override
	Solve the Riemann problem on the boundary face. More...

virtual void	calcJacobian (unsigned int iside, dof_id_type ielem, const std::vector< Real > &uvec1, const RealVectorValue &dwave, DenseMatrix< Real > &jac1) const override
	Compute the Jacobian matrix on the boundary face. More...

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
	Get the boundary flux vector. More...

virtual const DenseMatrix< Real > &	getJacobian (unsigned int iside, dof_id_type ielem, const std::vector< Real > &uvec1, const RealVectorValue &dwave) const
	Get the boundary Jacobian matrix. More...

Protected Attributes
const Real	_velocity
	advective velocity More...

unsigned int	_cached_flux_elem_id
	element ID of the cached flux values More...

unsigned int	_cached_flux_side_id
	side ID of the cached flux values More...

unsigned int	_cached_jacobian_elem_id
	element ID of the cached Jacobian values More...

unsigned int	_cached_jacobian_side_id
	side ID of the cached Jacobian values More...

std::vector< Real >	_flux
	Cached flux. More...

DenseMatrix< Real >	_jac1
	Cached flux Jacobian. More...

Detailed Description

Free outflow BC based boundary flux user object for the advection equation using a cell-centered finite volume method.

Definition at line 25 of file AEFVFreeOutflowBoundaryFlux.h.

Constructor & Destructor Documentation

◆ AEFVFreeOutflowBoundaryFlux()

AEFVFreeOutflowBoundaryFlux::AEFVFreeOutflowBoundaryFlux ( const InputParameters & parameters )

Definition at line 25 of file AEFVFreeOutflowBoundaryFlux.C.

   : BoundaryFluxBase(parameters), _velocity(getParam<Real>("velocity"))
 {
 }

◆ ~AEFVFreeOutflowBoundaryFlux()

AEFVFreeOutflowBoundaryFlux::~AEFVFreeOutflowBoundaryFlux ( )

virtual

Definition at line 30 of file AEFVFreeOutflowBoundaryFlux.C.

30 {}

Member Function Documentation

◆ calcFlux()

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

overridevirtual

Solve the Riemann problem on the boundary face.

Parameters

[in]	iside	local index of current side
[in]	ielem	global index of the current element
[in]	uvec1	vector of variables on the host side
[in]	dwave	vector of unit normal
[out]	flux	flux vector for conservation equations

Implements BoundaryFluxBase.

Definition at line 33 of file AEFVFreeOutflowBoundaryFlux.C.

 {
   mooseAssert(uvec1.size() == 1, "Invalid size for uvec1. Must be single variable coupling.");
  
   // assume the velocity vector is constant
   RealVectorValue uadv1(_velocity, 0.0, 0.0);
  
   // assign the size of flux vector, e.g. = 1 for the advection equation
   flux.resize(1);
  
   // finally calculate the flux
   flux[0] = (uadv1 * dwave) * uvec1[0];
 }

◆ calcJacobian()

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

overridevirtual

Compute the Jacobian matrix on the boundary face.

Parameters

[in]	iside	local index of current side
[in]	ielem	global index of the current element
[in]	uvec1	vector of variables on the host side
[in]	dwave	vector of unit normal
[out]	jac1	Jacobian matrix contribution

Implements BoundaryFluxBase.

Definition at line 52 of file AEFVFreeOutflowBoundaryFlux.C.

 {
   mooseAssert(uvec1.size() == 1, "Invalid size for uvec1. Must be single variable coupling.");
   jac1.resize(1, 1);
   // assume the velocity vector is constant
   const RealVectorValue uadv1(_velocity, 0.0, 0.0);
   jac1(0, 0) = uadv1 * dwave;
 }

◆ execute()

void BoundaryFluxBase::execute ( )

overridevirtualinherited

Definition at line 39 of file BoundaryFluxBase.C.

40 {

41 }

◆ finalize()

void BoundaryFluxBase::finalize ( )

overridevirtualinherited

Definition at line 44 of file BoundaryFluxBase.C.

45 {

46 }

◆ getFlux()

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

virtualinherited

Get the boundary flux vector.

Parameters

[in]	iside	local index of current side
[in]	ielem	global index of the current element
[in]	uvec1	vector of variables on the host side
[in]	dwave	vector of unit normal

Definition at line 54 of file BoundaryFluxBase.C.

 {
   if (_cached_flux_elem_id != ielem || _cached_flux_side_id != iside)
   {
     _cached_flux_elem_id = ielem;
     _cached_flux_side_id = iside;
  
     calcFlux(iside, ielem, uvec1, dwave, _flux);
   }
   return _flux;
 }

Referenced by BoundaryFluxPostprocessor::computeQpIntegral(), and AEFVBC::computeQpResidual().

◆ getJacobian()

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

virtualinherited

Get the boundary Jacobian matrix.

Parameters

[in]	iside	local index of current side
[in]	ielem	global index of the current element
[in]	uvec1	vector of variables on the host side
[in]	dwave	vector of unit normal

Definition at line 70 of file BoundaryFluxBase.C.

 {
   if (_cached_jacobian_elem_id != ielem || _cached_jacobian_side_id != iside)
   {
     _cached_jacobian_elem_id = ielem;
     _cached_jacobian_side_id = iside;
  
     calcJacobian(iside, ielem, uvec1, dwave, _jac1);
   }
   return _jac1;
 }

Referenced by AEFVBC::computeQpJacobian().

◆ initialize()

void BoundaryFluxBase::initialize ( )

overridevirtualinherited

Definition at line 30 of file BoundaryFluxBase.C.

 {
   _cached_flux_elem_id = libMesh::invalid_uint;
   _cached_flux_side_id = libMesh::invalid_uint;
   _cached_jacobian_elem_id = libMesh::invalid_uint;
   _cached_jacobian_side_id = libMesh::invalid_uint;
 }

◆ threadJoin()

void BoundaryFluxBase::threadJoin ( const UserObject & )

overridevirtualinherited

Definition at line 49 of file BoundaryFluxBase.C.

50 {

51 }

Member Data Documentation

◆ _cached_flux_elem_id

unsigned int BoundaryFluxBase::_cached_flux_elem_id

mutableprotectedinherited

element ID of the cached flux values

Definition at line 94 of file BoundaryFluxBase.h.

Referenced by BoundaryFluxBase::getFlux(), and BoundaryFluxBase::initialize().

◆ _cached_flux_side_id

unsigned int BoundaryFluxBase::_cached_flux_side_id

mutableprotectedinherited

side ID of the cached flux values

Definition at line 96 of file BoundaryFluxBase.h.

Referenced by BoundaryFluxBase::getFlux(), and BoundaryFluxBase::initialize().

◆ _cached_jacobian_elem_id

unsigned int BoundaryFluxBase::_cached_jacobian_elem_id

mutableprotectedinherited

element ID of the cached Jacobian values

Definition at line 99 of file BoundaryFluxBase.h.

Referenced by BoundaryFluxBase::getJacobian(), and BoundaryFluxBase::initialize().

◆ _cached_jacobian_side_id

unsigned int BoundaryFluxBase::_cached_jacobian_side_id

mutableprotectedinherited

side ID of the cached Jacobian values

Definition at line 101 of file BoundaryFluxBase.h.

Referenced by BoundaryFluxBase::getJacobian(), and BoundaryFluxBase::initialize().

◆ _flux

std::vector<Real> BoundaryFluxBase::_flux

mutableprotectedinherited

Cached flux.

Definition at line 104 of file BoundaryFluxBase.h.

Referenced by BoundaryFluxBase::getFlux().

◆ _jac1

DenseMatrix<Real> BoundaryFluxBase::_jac1

mutableprotectedinherited

Cached flux Jacobian.

Definition at line 107 of file BoundaryFluxBase.h.

Referenced by BoundaryFluxBase::getJacobian().

◆ _velocity

const Real AEFVFreeOutflowBoundaryFlux::_velocity

protected

advective velocity

Definition at line 45 of file AEFVFreeOutflowBoundaryFlux.h.

Referenced by calcFlux(), and calcJacobian().

The documentation for this class was generated from the following files:

rdg/include/userobjects/AEFVFreeOutflowBoundaryFlux.h
rdg/src/userobjects/AEFVFreeOutflowBoundaryFlux.C

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AEFVFreeOutflowBoundaryFlux()

◆ ~AEFVFreeOutflowBoundaryFlux()

Member Function Documentation

◆ calcFlux()

◆ calcJacobian()

◆ execute()

◆ finalize()

◆ getFlux()

◆ getJacobian()

◆ initialize()

◆ threadJoin()

Member Data Documentation

◆ _cached_flux_elem_id

◆ _cached_flux_side_id

◆ _cached_jacobian_elem_id

◆ _cached_jacobian_side_id

◆ _flux

◆ _jac1

◆ _velocity