File: FunctionExpressionVariable.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 (145 lines) | stat: -rw-r--r-- 3,356 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
134
135
136
137
138
139
140
141
142
143
144
145
//  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: FunctionExpressionVariable.hpp,v 1.3 2007/05/20 23:15:36 delpinux Exp $

#ifndef FUNCTION_EXPRESSION_VARIABLE_HPP
#define FUNCTION_EXPRESSION_VARIABLE_HPP

#include <Variable.hpp>
#include <FunctionExpression.hpp>

#include <DiscretizationType.hpp>

/**
 * @file   FunctionExpressionVariable.hpp
 * @author Stephane Del Pino
 * @date   Wed Jul 19 11:44:32 2006
 * 
 * @brief  Manages function expression variables
 * 
 */
class FunctionExpressionVariable
  : public FunctionExpression
{
private:
  /** 
   * writes an expression
   * 
   * @param os output stream
   * 
   * @return os
   */
  std::ostream& put(std::ostream& os) const;

  const std::string __functionName;

  ReferenceCounting<FunctionVariable>
  __functionVariable;		/**< the function variable */

  DiscretizationType::Type
  __discretizationType;		/**< Variables can be related to
				   discretization types */

public:
  /** 
   * Checks if the variable requires a boundary for evaluation
   * 
   * 
   * @return @b true if __functionVariable requires a boundary
   */
  bool hasBoundaryExpression() const
  {
    return __functionVariable->expression()->hasBoundaryExpression();
  }

  /** 
   * Subscribe the variable
   * 
   */
  void subscribe()
  {
    __functionVariable->subscribe();
  }

  /** 
   * Un-substrcibe the variable
   * 
   */
  void unsubscribe()
  {
    __functionVariable->unsubscribe();
  }

  /** 
   * Read only access to the discretization type
   * 
   * @return __discretizationType
   */
  const DiscretizationType::Type&
  discretizationType() const
  {
    return __discretizationType;
  }

  /** 
   * Read only access to the variable
   * 
   * @return __functionVariable
   */
  ConstReferenceCounting<FunctionVariable>
  variable() const;

  /** 
   * Access to the variable
   * 
   * @return __functionVariable
   */
  ReferenceCounting<FunctionVariable>
  variable();

  /** 
   * Executes the function expression
   * 
   */
  void execute();

  /** 
   * Constructor
   * 
   * @param functionName name of the variable
   * @param type a discretization type
   */
  FunctionExpressionVariable(const std::string& functionName,
			     const DiscretizationType::Type& type
			     = DiscretizationType::lagrangianFEM1);

  /** 
   * Copy constructor
   * 
   * @param functionVariable name of the variable
   */
  FunctionExpressionVariable(const FunctionExpressionVariable& functionVariable);

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

#endif // FUNCTION_EXPRESSION_VARIABLE_HPP