RDGFluxBase Class Reference

Abstract base class for computing and caching internal or boundary fluxes for RDG. More...

#include <RDGFluxBase.h>

Inheritance diagram for RDGFluxBase:

Public Member Functions
	RDGFluxBase (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 (const unsigned int iside, const dof_id_type ielem, const std::vector< Real > &uvec1, const std::vector< Real > &uvec2, const RealVectorValue &normal) const
	Gets the flux vector for an element/side combination. More...
virtual const DenseMatrix< Real > &	getJacobian (const bool get_first_jacobian, const unsigned int iside, const dof_id_type ielem, const std::vector< Real > &uvec1, const std::vector< Real > &uvec2, const RealVectorValue &normal) const
	Gets the flux Jacobian matrix for an element/side combination. More...
virtual void	calcFlux (const std::vector< Real > &uvec1, const std::vector< Real > &uvec2, const RealVectorValue &normal, std::vector< Real > &flux) const =0
	Calculates the flux vector given "left" and "right" states. More...
virtual void	calcJacobian (const std::vector< Real > &uvec1, const std::vector< Real > &uvec2, const RealVectorValue &normal, DenseMatrix< Real > &jac1, DenseMatrix< Real > &jac2) const =0
	Calculates the flux Jacobian matrices given "left" and "right" states. 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
	flux vector More...
DenseMatrix< Real >	_jac1
	Jacobian matrix contribution to the "left" cell. More...
DenseMatrix< Real >	_jac2
	Jacobian matrix contribution to the "right" cell. More...

Detailed Description

Abstract base class for computing and caching internal or boundary fluxes for RDG.

Here a call to compute flux computes the flux for all equations in the system, so to avoid duplicating the calculations, a wrapper is used to cache the system flux for an element/side combination.

Definition at line 26 of file RDGFluxBase.h.

Constructor & Destructor Documentation

RDGFluxBase()

RDGFluxBase::RDGFluxBase

(

const InputParameters &

parameters

)

Definition at line 22 of file RDGFluxBase.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 RDGFluxBase::calcFlux ( const std::vector< Real > &  uvec1, const std::vector< Real > &  uvec2, const RealVectorValue &  normal, std::vector< Real > &  flux  ) const

pure virtual

Calculates the flux vector given "left" and "right" states.

This function is called only if the values are not already cached.

Parameters

[in]	uvec1	vector of variables on the "left"
[in]	uvec2	vector of variables on the "right"
[in]	normal	vector of unit normal
[out]	flux	flux vector

Referenced by getFlux().

calcJacobian()

virtual void RDGFluxBase::calcJacobian ( const std::vector< Real > &  uvec1, const std::vector< Real > &  uvec2, const RealVectorValue &  normal, DenseMatrix< Real > &  jac1, DenseMatrix< Real > &  jac2  ) const

pure virtual

Calculates the flux Jacobian matrices given "left" and "right" states.

This function is called only if the values are not already cached.

Parameters

[in]	uvec1	vector of variables on the "left"
[in]	uvec2	vector of variables on the "right"
[in]	normal	vector of unit normal
[out]	jac1	Jacobian matrix contribution to the "left" cell
[out]	jac2	Jacobian matrix contribution to the "right" cell

Referenced by getJacobian().

execute()

void RDGFluxBase::execute ( )

overridevirtual

Definition at line 41 of file RDGFluxBase.C.

{
}

finalize()

void RDGFluxBase::finalize ( )

overridevirtual

Definition at line 46 of file RDGFluxBase.C.

{
}

getFlux()

const std::vector< Real > & RDGFluxBase::getFlux ( const unsigned int  iside, const dof_id_type  ielem, const std::vector< Real > &  uvec1, const std::vector< Real > &  uvec2, const RealVectorValue &  normal  ) const

virtual

Gets the flux vector for an element/side combination.

If the element/side is cached, the cached values are used. Otherwise the values are computed, cached, and returned.

Parameters

[in]	iside	local index of current side
[in]	ielem	global index of the current element
[in]	uvec1	vector of variables on the "left"
[in]	uvec2	vector of variables on the "right"
[in]	normal	vector of unit normal

Returns

flux vector for an element/side combination

Definition at line 56 of file RDGFluxBase.C.

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

getJacobian()

const DenseMatrix< Real > & RDGFluxBase::getJacobian ( const bool  get_first_jacobian, const unsigned int  iside, const dof_id_type  ielem, const std::vector< Real > &  uvec1, const std::vector< Real > &  uvec2, const RealVectorValue &  normal  ) const

virtual

Gets the flux Jacobian matrix for an element/side combination.

If the element/side is cached, the cached values are used. Otherwise the values are computed, cached, and returned. The user decides which Jacobian to receive (either with respect to first solution vector or second solution vector). If the user wants both, then the function can just be called a second time with the other Jacobian requested - since that Jacobian is already cached, no redundant calculations will occur.

Parameters

[in]	get_first_jacobian	get the Jacobian w.r.t. the first solution; else get the Jacobian w.r.t. the second solution
[in]	iside	local index of current side
[in]	ielem	global index of the current element
[in]	uvec1	vector of variables on the "left"
[in]	uvec2	vector of variables on the "right"
[in]	normal	vector of unit normal

Returns

flux Jacobian matrix for an element/side combination

Definition at line 73 of file RDGFluxBase.C.

{
  if (_cached_jacobian_elem_id != ielem || _cached_jacobian_side_id != iside)
  {
    _cached_jacobian_elem_id = ielem;
    _cached_jacobian_side_id = iside;
 
    calcJacobian(uvec1, uvec2, normal, _jac1, _jac2);
  }
 
  if (get_first_jacobian)
    return _jac1;
  else
    return _jac2;
}

initialize()

void RDGFluxBase::initialize ( )

overridevirtual

Definition at line 32 of file RDGFluxBase.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 RDGFluxBase::threadJoin ( const UserObject &  )

overridevirtual

Definition at line 51 of file RDGFluxBase.C.

{
}

Member Data Documentation

_cached_flux_elem_id

unsigned int RDGFluxBase::_cached_flux_elem_id

mutableprotected

element ID of the cached flux values

Definition at line 117 of file RDGFluxBase.h.

Referenced by getFlux(), and initialize().

_cached_flux_side_id

unsigned int RDGFluxBase::_cached_flux_side_id

mutableprotected

side ID of the cached flux values

Definition at line 119 of file RDGFluxBase.h.

Referenced by getFlux(), and initialize().

_cached_jacobian_elem_id

unsigned int RDGFluxBase::_cached_jacobian_elem_id

mutableprotected

element ID of the cached Jacobian values

Definition at line 122 of file RDGFluxBase.h.

Referenced by getJacobian(), and initialize().

_cached_jacobian_side_id

unsigned int RDGFluxBase::_cached_jacobian_side_id

mutableprotected

side ID of the cached Jacobian values

Definition at line 124 of file RDGFluxBase.h.

Referenced by getJacobian(), and initialize().

_flux

std::vector<Real> RDGFluxBase::_flux

mutableprotected

flux vector

Definition at line 127 of file RDGFluxBase.h.

Referenced by getFlux().

_jac1

DenseMatrix<Real> RDGFluxBase::_jac1

mutableprotected

Jacobian matrix contribution to the "left" cell.

Definition at line 129 of file RDGFluxBase.h.

Referenced by getJacobian().

_jac2

DenseMatrix<Real> RDGFluxBase::_jac2

mutableprotected

Jacobian matrix contribution to the "right" cell.

Definition at line 131 of file RDGFluxBase.h.

Referenced by getJacobian().

---

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

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