SlaughterFEM::EqBoundaryBase Class Reference

A base class for equation boundary conditions for integration with EqBase class. More...

#include <fem/equation_systems/eq_boundary_base.h>

Inheritance diagram for SlaughterFEM::EqBoundaryBase:

List of all members.

Public Member Functions
	EqBoundaryBase (std::string the_type)
	The constructor for the base class.
virtual void	value (DenseVector< Number > &output, const Point &, const Real)=0
	A pure virtual function for returning the desired value.
Public Attributes
int	id
	The boundary id.
const std::string	type
	The name of the boundary.
void(*	fptr )(DenseVector< Number > &, const Point &, const Real)
	A function pointer (libMesh required format)

---

Detailed Description

A base class for equation boundary conditions for integration with EqBase class.

Provides basic format for defining a boundary conditions for application to the Eq_base class. This class is used to provide uniform access for all types of boundaries that are derived from the base.

See also:

EqBase

HeatEqBoundaryBase

---

Constructor & Destructor Documentation

EqBoundaryBase::EqBoundaryBase

(

std::string

the_type

)

The constructor for the base class.

Parameters:

the_type

A string that indicates the type of boundary

Note that if the inherited class is to be recognized by the EqBase class as a dirichlet condition this value MUST be "dirichlet" as done with the HeatEqBoundaryDirichlet class.

See also:

HeatEqBoundaryDirichlet

---

Member Function Documentation

virtual void SlaughterFEM::EqBoundaryBase::value	(	DenseVector< Number > &	output,
		const Point &	,
		const Real
	)		[pure virtual]

A pure virtual function for returning the desired value.

For any class derived from this base class the value function must be defined. The value returned through the DenseVector reference is used by the Eq_base class when applying the boundary conditions.

See also:

Eq_base

Implemented in SlaughterFEM::HeatEqBoundaryConvection, SlaughterFEM::HeatEqBoundaryNeumann, and SlaughterFEM::HeatEqBoundaryDirichlet.

---

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

• include/fem/common/eq_boundary_base.h
• source/fem/common/eq_boundary_base.cpp