File: BoundaryCondition.hpp

package info (click to toggle)
freefem3d 1.0pre8-2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 13,920 kB
  • ctags: 7,145
  • sloc: cpp: 45,748; sh: 8,698; yacc: 2,847; makefile: 600; ansic: 504; perl: 110
file content (91 lines) | stat: -rw-r--r-- 2,382 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
//  This file is part of ff3d - http://www.freefem.org/ff3d
//  Copyright (C) 2001, 2002, 2003 Stphane Del Pino

//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2, or (at your option)
//  any later version.

//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.

//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software Foundation,
//  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  

//  $Id: BoundaryCondition.hpp,v 1.2 2004/04/16 16:25:41 delpinux Exp $

#ifndef BOUNDARYCONDITION_HPP
#define BOUNDARYCONDITION_HPP

#include <Boundary.hpp>
#include <PDECondition.hpp>

/*!
  \class BoundaryCondition

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

  \author Stphane Del Pino
*/

class BoundaryCondition
{
private:
  //! a PDE like condition.
  ReferenceCounting<PDECondition> __pdeCondition;

  //! The associated boundary.
  ReferenceCounting<Boundary> __boundary;

public:

  //! read only access to the boundary.
  const Boundary& boundary() const
  {
    return *__boundary;
  }

  //! Access to the boundary Reference.
  ReferenceCounting<Boundary> boundaryReference() const
  {
    return __boundary;
  }

  //! read only access to the condition.
  const PDECondition& condition() const
  {
    return *__pdeCondition;
  }

  //! Access to the boundary Reference.
  ReferenceCounting<PDECondition> pdeConditionReference() const
  {
    return __pdeCondition;
  }

  //! Writes the boundary condition.
  friend std::ostream& operator << (std::ostream& os,
				    const BoundaryCondition&  BC)
  {
    os << "Boundary Condition\n";
    os << *BC.__pdeCondition;
    os << *BC.__boundary;
    return os;
  }

  //! Constucts a BC using a Boundary and a Condition.
  BoundaryCondition(ReferenceCounting<PDECondition> pdeCondition,
		    ReferenceCounting<Boundary> aBoundary)
    : __pdeCondition(pdeCondition),
      __boundary(aBoundary)
  {
    ;
  }
};

#endif // BOUNDARYCONDITION_HPP