BoundaryFluxBase Class Reference

A base class for computing/caching fluxes at boundaries. More...

#include <BoundaryFluxBase.h>

Inheritance diagram for BoundaryFluxBase:

Public Member Functions
	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
	Get the boundary flux vector. More...
virtual void	calcFlux (unsigned int iside, dof_id_type ielem, const std::vector< Real > &uvec1, const RealVectorValue &dwave, std::vector< Real > &flux) const =0
	Solve the Riemann problem on the boundary face. 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...
virtual void	calcJacobian (unsigned int iside, dof_id_type ielem, const std::vector< Real > &uvec1, const RealVectorValue &dwave, DenseMatrix< Real > &jac1) const =0
	Compute the Jacobian matrix on the boundary face. More...

Protected Attributes
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

A base class for computing/caching fluxes at boundaries.

Notes:

1. When systems of equations are being solved, the fluxes are treated as vectors. To avoid recomputing the flux at the boundary, we compute it just once and then when it is needed, we just return the cached value.
2. Derived classes need to override calcFlux and calcJacobian.

Definition at line 30 of file BoundaryFluxBase.h.

Constructor & Destructor Documentation

BoundaryFluxBase()

BoundaryFluxBase::BoundaryFluxBase

(

const InputParameters &

parameters

)

Definition at line 20 of file BoundaryFluxBase.C.

  : ThreadedGeneralUserObject(parameters),
    _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)
{
}

Member Function Documentation

calcFlux()

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

pure virtual

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

Implemented in AEFVFreeOutflowBoundaryFlux, and TestBoundaryFlux.

Referenced by getFlux().

calcJacobian()

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

pure virtual

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

Implemented in AEFVFreeOutflowBoundaryFlux, and TestBoundaryFlux.

Referenced by getJacobian().

execute()

void BoundaryFluxBase::execute ( )

overridevirtual

Definition at line 39 of file BoundaryFluxBase.C.

{
}

finalize()

void BoundaryFluxBase::finalize ( )

overridevirtual

Definition at line 44 of file BoundaryFluxBase.C.

{
}

getFlux()

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

virtual

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

virtual

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 ( )

overridevirtual

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 &  )

overridevirtual

Definition at line 49 of file BoundaryFluxBase.C.

{
}

Member Data Documentation

_cached_flux_elem_id

unsigned int BoundaryFluxBase::_cached_flux_elem_id

mutableprotected

element ID of the cached flux values

Definition at line 94 of file BoundaryFluxBase.h.

Referenced by getFlux(), and initialize().

_cached_flux_side_id

unsigned int BoundaryFluxBase::_cached_flux_side_id

mutableprotected

side ID of the cached flux values

Definition at line 96 of file BoundaryFluxBase.h.

Referenced by getFlux(), and initialize().

_cached_jacobian_elem_id

unsigned int BoundaryFluxBase::_cached_jacobian_elem_id

mutableprotected

element ID of the cached Jacobian values

Definition at line 99 of file BoundaryFluxBase.h.

Referenced by getJacobian(), and initialize().

_cached_jacobian_side_id

unsigned int BoundaryFluxBase::_cached_jacobian_side_id

mutableprotected

side ID of the cached Jacobian values

Definition at line 101 of file BoundaryFluxBase.h.

Referenced by getJacobian(), and initialize().

_flux

std::vector<Real> BoundaryFluxBase::_flux

mutableprotected

Cached flux.

Definition at line 104 of file BoundaryFluxBase.h.

Referenced by getFlux().

_jac1

DenseMatrix<Real> BoundaryFluxBase::_jac1

mutableprotected

Cached flux Jacobian.

Definition at line 107 of file BoundaryFluxBase.h.

Referenced by getJacobian().

---

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

• rdg/include/userobjects/BoundaryFluxBase.h
• rdg/src/userobjects/BoundaryFluxBase.C