File: FirstOrderOperator.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 (181 lines) | stat: -rw-r--r-- 4,268 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
//  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: FirstOrderOperator.hpp,v 1.6 2007/02/14 21:53:19 delpinux Exp $


#ifndef FIRST_ORDER_OPERATOR_HPP
#define FIRST_ORDER_OPERATOR_HPP

#include <PDEOperator.hpp>

/**
 * @file   FirstOrderOperator.hpp
 * @author Stephane Del Pino
 * @date   Wed Jul 19 18:41:41 2006
 * 
 * @brief First order operator
 * 
 * This class describes the first order partial differencial
 * operators: @f$ \nu\cdot\nabla @f$ where @f$ \nu @f$ is a dimension
 * 3 function vector.
 * 
 * @par example: if @f$ \nu = (1,1,1) @f$, the operator is
 * @f$\partial_x+\partial_y+\partial_z@f$.
 * 
 */
class FirstOrderOperator
  : public PDEOperator
{
public:
  typedef TinyVector<3,ConstReferenceCounting<ScalarFunctionBase> > Vector;

private:
  ConstReferenceCounting<FirstOrderOperator::Vector>
  __nu;				/**< coefficients vector */

public:
  /** 
   * Gets operator name
   * 
   * @return "FirstOrderOperator"
   */
  std::string
  typeName() const
  {
    return std::string("FirstOrderOperator");
  }

  /** 
   * Checks if component @a i of @f$ \nu @f$ is set
   * 
   * @param i number of the component
   * 
   * @return @a true if @f$ \nu_i @f$ has been set
   */
  bool isSet(const int&i) const
  {
    return ((*__nu)[i] != 0);
  }

  /** 
   * Read-only access to operator coefficient @a i
   * 
   * @param i number of the component
   * 
   * @return @f$ \nu_i @f$ 
   */
  ConstReferenceCounting<ScalarFunctionBase>
  nu(const size_t& i) const
  {
    return (*__nu)[i];
  }

  /** 
   * Read-only access to operator coefficients
   * 
   * @return @f$ \nu @f$ 
   */
  ConstReferenceCounting<FirstOrderOperator::Vector>
  nu() const
  {
    return __nu;
  }

  /** 
   * Returns a pointer on the "multiplied" by u FirstOrderOperator
   * 
   * @param c the multiplicative coefficient
   * 
   * @return @f$ (c\nu)\cdot\nabla @f$
   */
  ConstReferenceCounting<PDEOperator>
  operator*(const ConstReferenceCounting<ScalarFunctionBase>& c) const
  {
    ReferenceCounting<FirstOrderOperator::Vector> nu2
      = new FirstOrderOperator::Vector;

    for (size_t i=0; i<3; ++i) {
      if (this->isSet(i)) {
	ScalarFunctionBuilder functionBuilder;
	functionBuilder.setFunction((*__nu)[i]);
	functionBuilder.setBinaryOperation(BinaryOperation::product,c);
	(*nu2)[i] = functionBuilder.getBuiltFunction();
      }
    }

    return new FirstOrderOperator(nu2);
  }

  /** 
   * Returns a pointer on the opposed FirstOrderOperator operator.
   * 
   * @return @f$ -\nu\cdot\nabla @f$
   */
  ConstReferenceCounting<PDEOperator>
  operator-() const
  {
    ReferenceCounting<FirstOrderOperator::Vector> nu2
      = new FirstOrderOperator::Vector;

    for (size_t i=0; i<3; ++i) {
      if (this->isSet(i)) {
	ScalarFunctionBuilder functionBuilder;
	functionBuilder.setFunction((*__nu)[i]);
	functionBuilder.setUnaryMinus();
	(*nu2)[i] = functionBuilder.getBuiltFunction();
      }
    }
    return new FirstOrderOperator(nu2);
  }

  /** 
   * Constructor
   * 
   * @param nu given @f$ nu @f$
   */
  FirstOrderOperator(ReferenceCounting<FirstOrderOperator::Vector> nu)
    : PDEOperator(PDEOperator::firstorderop,
		  3),
      __nu(nu)
  {
    ;
  }

  /** 
   * Copy constructor
   * 
   * @param o given first order operator
   */
  FirstOrderOperator(const FirstOrderOperator& o)
    : PDEOperator(o),
      __nu(o.__nu)
  {
    ;
  }

  /** 
   * Destructor
   * 
   */
  ~FirstOrderOperator()
  {
    ;
  }
};

#endif // FIRST_ORDER_OPERATOR_HPP