File: ScalarFunctionIntegrate.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 (118 lines) | stat: -rw-r--r-- 3,271 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
//  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: ScalarFunctionIntegrate.hpp,v 1.4 2006/10/28 12:26:54 delpinux Exp $

#ifndef SCALAR_FUNCTION_INTEGRATE_HPP
#define SCALAR_FUNCTION_INTEGRATE_HPP

#include <ScalarFunctionBase.hpp>
#include <FEMFunctionBase.hpp>

/**
 * @file   ScalarFunctionIntegrate.hpp
 * @author Stephane Del Pino
 * @date   Thu Jul 20 01:35:04 2006
 * 
 * @brief  integrates a function in a direction @f$ \int_a^b f dx_i @f$
 *  
 * @bug only implemented for FEM functions
 */
class ScalarFunctionIntegrate
  : public ScalarFunctionBase
{
public:
  enum Direction {
    x=0,
    y=1,
    z=2
  };

private:
  ConstReferenceCounting<ScalarFunctionBase>
  __lowerBound;			/**< lower bound of integration @f$ a @f$ */
  ConstReferenceCounting<ScalarFunctionBase>
  __upperBound;			/**< upper bound of integration @f$ b @f$ */
  ConstReferenceCounting<FEMFunctionBase>
  __functionToIntegrate;	/**< function to integrate @f$ f @f$ */
  const Direction __direction;	/**< direction of integration */

  /** 
   * Evaluate the function using the mesh specialization
   * 
   * @param X the position evaluation
   */
  template <typename MeshType>
  real_t __evaluate(const TinyVector<3,real_t>& X) const;

  /** 
   * Writes the function to a stream
   * 
   * @param os output stream
   * 
   * @return os
   */
  std::ostream& __put(std::ostream& os) const;

public:
  /** 
   * Evaluates the function to the position @f$ X @f$
   * 
   * @param X position
   * 
   * @return @f$ \int_d f @f$
   */
  real_t operator()(const TinyVector<3,real_t>& X) const;

  /** 
   * Checks if the function can be simplified
   * 
   * @return false
   */
  bool canBeSimplified() const
  {
    return false;
  }

  /** 
   * Constructor
   * 
   * @param lowerBound lower bound of integration @f$ a @f$
   * @param upperBound upper bound of integration @f$ b @f$
   * @param functionToIntegrated function to integrate
   * @param direction direction of integration
   */
  ScalarFunctionIntegrate(ConstReferenceCounting<ScalarFunctionBase> lowerBound,
			  ConstReferenceCounting<ScalarFunctionBase> upperBound,
			  ConstReferenceCounting<ScalarFunctionBase> functionToIntegrated,
			  const ScalarFunctionIntegrate::Direction& direction);

  /** 
   * Copy contructor
   * 
   * @param f original function
   */
  ScalarFunctionIntegrate(const ScalarFunctionIntegrate& f);

  /** 
   * Destructor
   * 
   */
  ~ScalarFunctionIntegrate();
};

#endif // SCALAR_FUNCTION_INTEGRATE_HPP