ComponentBoundaryConditions Class Reference

#include <ComponentBoundaryConditions.hpp>

List of all members.

Public Member Functions

void AddBoundaryCondition (const BoundaryCondition &BC)
 Add a boundary condition to the list.
const size_t NbBoundaryCondition () const
 read only access to the number of boundary condition.
const BoundaryConditionoperator[] (const size_t i) const
 returns the ith boundary condition.
 ComponentBoundaryConditions (const ComponentBoundaryConditions &CBC)
 Copy contructor.
 ComponentBoundaryConditions ()
 Default constructor is void.

Private Attributes

std::vector< const
BoundaryCondition * > 
bclist
 The list of Boundary Conditions.

Friends

std::ostream & operator<< (std::ostream &os, const ComponentBoundaryConditions &CBC)
 writes the ComponentBoundaryConditions.


Detailed Description

This class is used to describe sets of boundary conditions applied to a scalar unknown.

Author:
Stéphane Del Pino

Definition at line 35 of file ComponentBoundaryConditions.hpp.


Constructor & Destructor Documentation

ComponentBoundaryConditions::ComponentBoundaryConditions ( const ComponentBoundaryConditions CBC  )  [inline]

Copy contructor.

Definition at line 73 of file ComponentBoundaryConditions.hpp.

00074     : bclist(CBC.bclist)
00075   {
00076     ;
00077   }

ComponentBoundaryConditions::ComponentBoundaryConditions (  )  [inline]

Default constructor is void.

Definition at line 80 of file ComponentBoundaryConditions.hpp.

00081   {
00082     ;
00083   }


Member Function Documentation

void ComponentBoundaryConditions::AddBoundaryCondition ( const BoundaryCondition BC  )  [inline]

Add a boundary condition to the list.

Definition at line 44 of file ComponentBoundaryConditions.hpp.

References bclist.

00045   {
00046     bclist.push_back(&BC);
00047   }

const size_t ComponentBoundaryConditions::NbBoundaryCondition (  )  const [inline]

read only access to the number of boundary condition.

Definition at line 51 of file ComponentBoundaryConditions.hpp.

References bclist.

00052   {
00053     return bclist.size();
00054   }

const BoundaryCondition& ComponentBoundaryConditions::operator[] ( const size_t  i  )  const [inline]

returns the ith boundary condition.

Definition at line 57 of file ComponentBoundaryConditions.hpp.

References ASSERT, and bclist.

00058   {
00059     ASSERT(i<bclist.size());
00060     return *(bclist[i]);
00061   }


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const ComponentBoundaryConditions CBC 
) [friend]

writes the ComponentBoundaryConditions.

Definition at line 64 of file ComponentBoundaryConditions.hpp.

00066   {
00067     for(size_t i=0; i<CBC.bclist.size(); ++i)
00068       os << *(CBC.bclist[i]) << '\n';
00069     return os;
00070   }


Member Data Documentation

The list of Boundary Conditions.

Definition at line 39 of file ComponentBoundaryConditions.hpp.

Referenced by AddBoundaryCondition(), NbBoundaryCondition(), and operator[]().


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

Generated on Wed Nov 19 00:05:01 2008 for FreeFEM3D (aka ff3d) by  doxygen 1.5.6