Base class for general, non-constant Neumann boundary conditions. More...

#include <neumann_func_obj.h>

Inheritance diagram for GRINS::NeumannFuncObj:

Public Member Functions
	NeumannFuncObj ()

virtual	~NeumannFuncObj ()

virtual libMesh::Point	value (const AssemblyContext &context, const CachedValues &cache, const unsigned int qp)
	Returns the value of the implemented Neumann boundary condition. More...

virtual libMesh::Real	normal_value (const AssemblyContext &context, const CachedValues &cache, const unsigned int qp)
	Returns the value of the implemented Neumann boundary condition. More...

virtual libMesh::Point	derivative (const AssemblyContext &context, const CachedValues &cache, const unsigned int qp)
	Returns the derivative with respect to the primary variable of the implemented Neumann boundary condition. More...

virtual libMesh::Real	normal_derivative (const AssemblyContext &context, const CachedValues &cache, const unsigned int qp)
	Returns the derivative with respect to the primary variable of the implemented Neumann boundary condition. More...

virtual libMesh::Point	derivative (const AssemblyContext &context, const CachedValues &cache, const unsigned int qp, const GRINS::VariableIndex jac_var)
	If needed, returns the derivative with respect to other variables in the system. More...

virtual libMesh::Real	normal_derivative (const AssemblyContext &context, const CachedValues &cache, const unsigned int qp, const GRINS::VariableIndex jac_var)
	If needed, returns the derivative with respect to other variables in the system. More...

const std::vector< VariableIndex > &	get_other_jac_vars ()

Protected Attributes
std::vector< VariableIndex >	_jac_vars

Detailed Description

Base class for general, non-constant Neumann boundary conditions.

Definition at line 44 of file neumann_func_obj.h.

Constructor & Destructor Documentation

GRINS::NeumannFuncObj::NeumannFuncObj ( )

Definition at line 36 of file neumann_func_obj.C.

   {
     return;
   }

GRINS::NeumannFuncObj::~NeumannFuncObj ( )

virtual

Definition at line 41 of file neumann_func_obj.C.

   {
     return;
   }

Member Function Documentation

libMesh::Point GRINS::NeumannFuncObj::derivative	(	const AssemblyContext &	context,
		const CachedValues &	cache,
		const unsigned int	qp
	)

virtual

Returns the derivative with respect to the primary variable of the implemented Neumann boundary condition.

This will leverage the FEMContext to get variable values and derivatives through the side_value, side_gradient, etc. interfaces, for each quadrature point qp.

Reimplemented in GRINS::ZeroFluxBC.

Definition at line 64 of file neumann_func_obj.C.

   {
     // By default, does nothing.
     /* \todo Should we libmesh_error() instead?*/
     return libMesh::Point(0.0,0.0,0.0);
   }

libMesh::Point GRINS::NeumannFuncObj::derivative	(	const AssemblyContext &	context,
		const CachedValues &	cache,
		const unsigned int	qp,
		const GRINS::VariableIndex	jac_var
	)

virtual

If needed, returns the derivative with respect to other variables in the system.

By default, does nothing. User should reimplement is this is needed. This will leverage the FEMContext to get variable values and derivatives through the side_value, side_gradient, etc. interfaces, for each quadrature point qp.

Reimplemented in GRINS::ZeroFluxBC.

Definition at line 73 of file neumann_func_obj.C.

   {
     // By default, does nothing.
     /* \todo Should we libmesh_error() instead?*/
     return libMesh::Point(0.0,0.0,0.0);
   }

const std::vector< VariableIndex > & GRINS::NeumannFuncObj::get_other_jac_vars ( )

Definition at line 103 of file neumann_func_obj.C.

References _jac_vars.

   {
     return _jac_vars;
   }

virtual libMesh::Real GRINS::NeumannFuncObj::normal_derivative	(	const AssemblyContext &	context,
		const CachedValues &	cache,
		const unsigned int	qp
	)

virtual

Returns the derivative with respect to the primary variable of the implemented Neumann boundary condition.

This will leverage the FEMContext to get variable values and derivatives through the side_value, side_gradient, etc. interfaces, for each quadrature point qp. Returns the normal component of the Neumann value. Only to be used when flux vector is formulated implicitly in terms of normal component. By default, does nothing since it's only applicable in special cases.

libMesh::Real GRINS::NeumannFuncObj::normal_derivative	(	const AssemblyContext &	context,
		const CachedValues &	cache,
		const unsigned int	qp,
		const GRINS::VariableIndex	jac_var
	)

virtual

If needed, returns the derivative with respect to other variables in the system.

By default, does nothing. User should reimplement is this is needed. This will leverage the FEMContext to get variable values and derivatives through the side_value, side_gradient, etc. interfaces, for each quadrature point qp. Returns the normal component of the Neumann value. Only to be used when flux vector is formulated implicitly in terms of normal component. By default, does nothing since it's only applicable in special cases.

Definition at line 93 of file neumann_func_obj.C.

   {
     // By default, does nothing.
     /* \todo Should we libmesh_error() instead?*/
     return 0.0;
   }

libMesh::Real GRINS::NeumannFuncObj::normal_value	(	const AssemblyContext &	context,
		const CachedValues &	cache,
		const unsigned int	qp
	)

virtual

Returns the value of the implemented Neumann boundary condition.

This will leverage the FEMContext to get variable values and derivatives through the side_value, side_gradient, etc. interfaces, for each quadrature point qp. Returns the normal component of the Neumann value. Only to be used when flux vector is formulated implicitly in terms of normal component. By default, does nothing since it's only applicable in special cases.

Definition at line 55 of file neumann_func_obj.C.

   {
     // By default, does nothing.
     /* \todo Should we libmesh_error() instead?*/
     return 0.0;
   }

libMesh::Point GRINS::NeumannFuncObj::value	(	const AssemblyContext &	context,
		const CachedValues &	cache,
		const unsigned int	qp
	)

virtual

Returns the value of the implemented Neumann boundary condition.

This will leverage the FEMContext to get variable values and derivatives through the side_value, side_gradient, etc. interfaces, for each quadrature point qp.

Reimplemented in GRINS::ZeroFluxBC.

Definition at line 46 of file neumann_func_obj.C.

   {
     // By default, does nothing.
     /* \todo Should we libmesh_error() instead?*/
     return libMesh::Point();
   }

Member Data Documentation

std::vector<VariableIndex> GRINS::NeumannFuncObj::_jac_vars

protected

Definition at line 105 of file neumann_func_obj.h.

Referenced by get_other_jac_vars().

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

src/boundary_conditions/include/grins/neumann_func_obj.h
src/boundary_conditions/src/neumann_func_obj.C

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation