Boundary Class Reference

#include <Boundary.hpp>

Inheritance diagram for Boundary:

[legend]

List of all members.

Public Types
enum	Type {   povRay, structured3DMesh, surfaceMesh, references,   list }
Public Member Functions
const Boundary::Type &	type () const
	Returns the type of the boundary.
	Boundary (const Boundary &B)
	copy constructor.
	Boundary (const Boundary::Type aType)
	constructs the boundary.
virtual	~Boundary ()
Private Member Functions
virtual void	put (std::ostream &os) const =0
	ostream overload.
Private Attributes
const Boundary::Type	__type
	The boundary type.
Friends
std::ostream &	operator<< (std::ostream &os, const Boundary &B)
	Writes the boundary conditions.

---

Detailed Description

Definition at line 33 of file Boundary.hpp.

---

Member Enumeration Documentation

enum Boundary::Type

Enumerator:

povRay
structured3DMesh
surfaceMesh
references
list

Definition at line 36 of file Boundary.hpp.

            {
    povRay,
    structured3DMesh,
    surfaceMesh,
    references,
    list
  };

---

Constructor & Destructor Documentation

Boundary::Boundary

(

const Boundary &

B

)

[inline]

copy constructor.

Definition at line 66 of file Boundary.hpp.

    : __type(B.__type)
  {
    ;
  }

Boundary::Boundary

(

const Boundary::Type

aType

)

[inline]

constructs the boundary.

Definition at line 73 of file Boundary.hpp.

    : __type(aType)
  {
    ;
  }

virtual Boundary::~Boundary

(

)

[inline, virtual]

Definition at line 79 of file Boundary.hpp.

  {
    ;
  }

---

Member Function Documentation

virtual void Boundary::put

(

std::ostream &

os

)

const [private, pure virtual]

ostream overload.

Implemented in BoundaryList, BoundaryPOVRay, BoundaryReferences, and BoundarySurfaceMesh.

const Boundary::Type& Boundary::type

(

)

const [inline]

Returns the type of the boundary.

Definition at line 52 of file Boundary.hpp.

References __type.

Referenced by BoundaryMeshAssociation::setPOVMeshes().

  {
    return __type;
  }

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const Boundary &	B
	)			[friend]

Writes the boundary conditions.

Definition at line 58 of file Boundary.hpp.

  {
    B.put(os);
    return os;
  }

---

Member Data Documentation

const Boundary::Type Boundary::__type [private]

The boundary type.

Definition at line 45 of file Boundary.hpp.

Referenced by type().

---

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

• Boundary.hpp