File: PDEProblem.hpp

package info (click to toggle)
freefem3d 1.0pre10-2
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 24,816 kB
  • ctags: 8,361
  • sloc: cpp: 57,201; sh: 8,788; yacc: 2,975; makefile: 1,148; ansic: 508; perl: 110
file content (133 lines) | stat: -rw-r--r-- 3,043 bytes parent folder | download | duplicates (5)
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
//  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: PDEProblem.hpp,v 1.3 2006/07/20 19:08:54 delpinux Exp $

#ifndef PDE_PROBLEM_HPP
#define PDE_PROBLEM_HPP

#include <PDE.hpp>
#include <BoundaryConditionSet.hpp>

#include <StreamCenter.hpp>

/**
 * @file   PDEProblem.hpp
 * @author Stephane Del Pino
 * @date   Thu Jul 20 00:00:39 2006
 * 
 * @brief  this class defines PDE problems
 * 
 */
class PDEProblem
{
private:
  ConstReferenceCounting<PDE> __pde; /**< a given PDE */

  ReferenceCounting<BoundaryConditionSet>
  __boundaryConditionSet;	/**< a given boundary condition set */

public:
  /** 
   * Read only access to the PDE
   * 
   * @return *__pde
   */
  const PDE& pde() const
  {
    return *__pde;
  }

  /** 
   * Read-only access to the boundary condition set
   * 
   * @return *__boundaryConditionSet
   */
  const BoundaryConditionSet&
  boundaryConditionSet() const
  {
    return *__boundaryConditionSet;
  }

  /** 
   * "multiplies" a PDE problem by a coefficient @a c
   * 
   * @param c the coefficient
   * 
   * @return the new PDEProblem
   */
  ReferenceCounting<PDEProblem>
  operator*(const ConstReferenceCounting<ScalarFunctionBase>& c) const
  {
    PDEProblem* newPDEProblem = new PDEProblem(*this);
    newPDEProblem->__pde = (*__pde) * c;
    return newPDEProblem;
  }

  /** 
   * Writes the PDE problem to a stream
   * 
   * @param os given stream
   * @param P the problem
   * 
   * @return os
   */
  friend std::ostream&
  operator << (std::ostream& os, const PDEProblem& P)
  {
    os << *P.__pde << '\n';
    os << *P.__boundaryConditionSet;
    return os;
  }

  /** 
   * Constructor
   * 
   * @param pde given PDE
   * @param boundaryConditionSet a boundary condition set
   */
  PDEProblem(ReferenceCounting<PDE> pde,
	     ReferenceCounting<BoundaryConditionSet> boundaryConditionSet)
    : __pde(pde),
      __boundaryConditionSet(boundaryConditionSet)
  {
    ;
  }

  /** 
   * Copy constructor
   * 
   * @param pdeProblem a given PDE problem
   */
  PDEProblem(const PDEProblem& pdeProblem)
    : __pde(pdeProblem.__pde),
      __boundaryConditionSet(pdeProblem.__boundaryConditionSet)
  {
    ;
  }

  /** 
   * Destructor
   * 
   */
  virtual ~PDEProblem()
  {
    ;
  }
};

#endif // PDE_PROBLEM_HPP