SlaughterFEM::HeatEqBoundaryBase Class Reference

A base class for heat equation boundary conditions. More...

#include <fem/heat_eq/heat_eq_boundary.h>

Inheritance diagram for SlaughterFEM::HeatEqBoundaryBase:

Collaboration diagram for SlaughterFEM::HeatEqBoundaryBase:

List of all members.

Public Member Functions
	HeatEqBoundaryBase (std::string the_type)
	The constructor for the base class of heat equation boundaries.
virtual Number	T (const Point &p, const Real t)
	A function for returning temperature for dirichlet condition.
virtual Number	h (const Point &p, const Real t)
	A function for returning convection term, h.
virtual Number	Tinf (const Point &p, const Real t)
	A function for returning convection term, Tinf.
virtual Real	q (const Point &p, const Real t)
	A function for returning neumann condition term, q.

---

Detailed Description

A base class for heat equation boundary conditions.

Provides basic format for defining a boundary conditions for application to the HeatEq class. This class is used to provide uniform access for all types of boundaries that are dervied from the base, as is in the case for the HeatEq class.

See also:

HeatEqBoundaryDirichlet

HeatEqBoundaryNeumann

HeatEqBoundaryConvection

---

Constructor & Destructor Documentation

HeatEqBoundaryBase::HeatEqBoundaryBase

(

std::string

the_type

)

The constructor for the base class of heat equation boundaries.

Parameters:

the_type

A string that indicates the type of boundary

Three types are currently supported:

• "dirichlet"
• "convection"
• "neumann"

---

Member Function Documentation

virtual Number SlaughterFEM::HeatEqBoundaryBase::h	(	const Point &	p,
		const Real	t
	)		[inline, virtual]

A function for returning convection term, h.

Parameters:

p	A libMesh Point
t	The current time

Reimplemented in SlaughterFEM::HeatEqBoundaryConvection.

virtual Real SlaughterFEM::HeatEqBoundaryBase::q	(	const Point &	p,
		const Real	t
	)		[inline, virtual]

A function for returning neumann condition term, q.

Parameters:

p	A libMesh Point
t	The current time

Reimplemented in SlaughterFEM::HeatEqBoundaryNeumann.

virtual Number SlaughterFEM::HeatEqBoundaryBase::T	(	const Point &	p,
		const Real	t
	)		[inline, virtual]

A function for returning temperature for dirichlet condition.

Parameters:

p	A libMesh Point
t	The current time

Reimplemented in SlaughterFEM::HeatEqBoundaryDirichlet.

virtual Number SlaughterFEM::HeatEqBoundaryBase::Tinf	(	const Point &	p,
		const Real	t
	)		[inline, virtual]

A function for returning convection term, Tinf.

Parameters:

p	A libMesh Point
t	The current time

Reimplemented in SlaughterFEM::HeatEqBoundaryConvection.

---

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

• include/fem/heat_eq/heat_eq_boundary.h
• source/fem/heat_eq/heat_eq_boundary.cpp