File: FEMFunctionBuilder.hpp

package info (click to toggle)
freefem3d 1.0pre10-3.4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 25,016 kB
  • ctags: 8,675
  • sloc: cpp: 57,204; sh: 8,788; yacc: 2,975; makefile: 1,149; ansic: 508; perl: 110
file content (119 lines) | stat: -rw-r--r-- 3,130 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
//  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: FEMFunctionBuilder.hpp,v 1.5 2007/05/20 23:22:26 delpinux Exp $

#ifndef FEM_FUNCTION_BUILDER_HPP
#define FEM_FUNCTION_BUILDER_HPP

#include <ReferenceCounting.hpp>
#include <Vector.hpp>

class ScalarFunctionBase;
class FEMFunctionBase;
class Mesh;

/**
 * @file   FEMFunctionBuilder.hpp
 * @author Stephane Del Pino
 * @date   Wed Jul 19 18:11:58 2006
 * 
 * @brief Factory for finite element functions
 * 
 * 
 */
class FEMFunctionBuilder
{
private:
  ReferenceCounting<FEMFunctionBase>
  __builtFunction;		/**< the built function */

  /** 
   * Template function that builds the function according to a mesh
   * type and a kind of discretization
   * 
   * @param d discretization type
   * @param mesh specialized type mesh
   */
  template <typename MeshType>
  void __build(const DiscretizationType& d,
	       const MeshType* mesh);

public:
  /** 
   * General function to build a function according to a mesh and a
   * discretization type
   * 
   * @param d discretization type
   * @param mesh a mesh
   */
  void build(const DiscretizationType& d, const Mesh* mesh);

  /** 
   * Build a function whose values are initialized to a given @f$ f @f$
   * 
   * @param d discretization type
   * @param mesh a mesh
   * @param f given function
   */
  void build(const DiscretizationType& d,
	     const Mesh* mesh,
	     const ScalarFunctionBase& f);

  /** 
   * Build a function whose values are initialized to given values
   * 
   * @param d discretization type
   * @param mesh a mesh
   * @param values given values
   * @param outsideValue returned value outside the mesh (necessary
   * for function simplification)
   */
  void build(const DiscretizationType& d,
	     const Mesh* mesh,
	     const Vector<real_t>& values,
	     const real_t& outsideValue = 0);

  /** 
   * Access to the built function
   * 
   * @return __builtFunction
   */
  ReferenceCounting<FEMFunctionBase> getBuiltFEMFunction();

  /** 
   * Read-only access to the built function viewed as a standard
   * scalar function
   * 
   * @return __builtFunction
   */
  ConstReferenceCounting<ScalarFunctionBase> getBuiltScalarFunction() const;

  /** 
   * Constructor
   * 
   */
  FEMFunctionBuilder();

  /** 
   * Detructor
   * 
   */
  ~FEMFunctionBuilder();
};

#endif // FEM_FUNCTION_BUILDER_HPP