PDECondition Class Reference

#include <PDECondition.hpp>

Inheritance diagram for PDECondition:

[legend]

List of all members.

Public Types
enum	Type { dirichlet, neumann, fourrier }
	allowed types. More...
Public Member Functions
const size_t &	unknownNumber () const
const PDECondition::Type &	type () const
	PDECondition (const PDECondition::Type &type, const size_t &unknownNumber)
	PDECondition (const PDECondition &C)
virtual	~PDECondition ()
Private Member Functions
virtual std::string	typeName () const =0
Private Attributes
const PDECondition::Type	__type
const size_t	__unknownNumber
Friends
std::ostream &	operator<< (std::ostream &os, const PDECondition &bc)

---

Detailed Description

Definition at line 35 of file PDECondition.hpp.

---

Member Enumeration Documentation

enum PDECondition::Type

allowed types.

Enumerator:

dirichlet
neumann
fourrier

Definition at line 39 of file PDECondition.hpp.

            {
    dirichlet,
    neumann,
    fourrier
  };

---

Constructor & Destructor Documentation

PDECondition::PDECondition	(	const PDECondition::Type &	type,
		const size_t &	unknownNumber
	)			[inline]

Constructor

Parameters:

	type	type of condition
	unknownNumber	unknown number

Definition at line 86 of file PDECondition.hpp.

    : __type(type),
      __unknownNumber(unknownNumber)
  {
    ;
  }

PDECondition::PDECondition

(

const PDECondition &

C

)

[inline]

Copy constructor

Parameters:

C

given condition

Definition at line 99 of file PDECondition.hpp.

    : __type(C.__type),
      __unknownNumber(C.__unknownNumber)
  {
    ;
  }

virtual PDECondition::~PDECondition

(

)

[inline, virtual]

Destructor

Definition at line 125 of file PDECondition.hpp.

  {
    ;
  }

---

Member Function Documentation

virtual std::string PDECondition::typeName

(

)

const [private, pure virtual]

gets type name of a boundary condition

Returns:

a string containing the name

Implemented in Dirichlet, Fourrier, and Neumann.

const size_t& PDECondition::unknownNumber

(

)

const [inline]

Read-only access to the unknown number

Returns:

__unknownNumber

Definition at line 64 of file PDECondition.hpp.

References __unknownNumber.

Referenced by BoundaryConditionSurfaceMeshAssociation::addPDEBoundaryConditionAndMesh().

  {
    return __unknownNumber;
  }

const PDECondition::Type& PDECondition::type

(

)

const [inline]

Read-only access to the type of condition

Returns:

__type

Definition at line 75 of file PDECondition.hpp.

References __type.

  {
    return __type;
  }

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const PDECondition &	bc
	)			[friend]

Writes the condition

Parameters:

	os	output stream
	bc	the condition to write

Returns:

os

Definition at line 115 of file PDECondition.hpp.

  {
    os << bc.typeName();
    return os;
  }

---

Member Data Documentation

const PDECondition::Type PDECondition::__type [private]

type of condition

Definition at line 46 of file PDECondition.hpp.

Referenced by type().

const size_t PDECondition::__unknownNumber [private]

number of the associated unknown

Definition at line 48 of file PDECondition.hpp.

Referenced by unknownNumber().

---

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

• PDECondition.hpp