Debian Codegraph @

src/math/aslTemplateVEExtras.h

raw
1 /*
2 * Advanced Simulation Library <http://asl.org.il>
3 *
4 * Copyright 2015 Avtech Scientific <http://avtechscientific.com>
5 *
6 *
7 * This file is part of Advanced Simulation Library (ASL).
8 *
9 * ASL is free software: you can redistribute it and/or modify it
10 * under the terms of the GNU Affero General Public License as
11 * published by the Free Software Foundation, version 3 of the License.
12 *
13 * ASL is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Affero General Public License for more details.
17 *
18 * You should have received a copy of the GNU Affero General Public License
19 * along with ASL. If not, see <http://www.gnu.org/licenses/>.
20 *
21 */
22
23
24 #ifndef TEMPLATEVEEXTRAS_H_INCLUDED
25 #define TEMPLATEVEEXTRAS_H_INCLUDED
26
27 #include <acl/aclMath/aclVectorOfElements.h>
28 #include "data/aslDataWithGhostNodes.h"
29 #include "aslTemplates.h"
30
31 /**
32 \defgroup DifferentialOpperators Differential Operrators
33 */
34
35 namespace asl
36 {
37 /// returns VectorOfElements containing values in cell corners \ingroup DifferentialOpperators
38 acl::VectorOfElements cellValues(const TemplateVE & a, unsigned int iEl);
39
40 /// differential operator \f$ \vec\nabla a \f$ within a cell \ingroup DifferentialOpperators
41 acl::VectorOfElements gradient(const TemplateVE & a, unsigned int iEl);
42
43 /// differential operator \f$ \vec\nabla a \f$ within all cells \ingroup DifferentialOpperators
44 /**
45 The function generates code that computes the gradient values in each cell. The
46 gradient values are written in \p values which are private variables. The corresponding
47 amount of variables are automaticaly generated.
48 */
49 vector<acl::Element> gcGradientAllCells(const TemplateVE & a,
50 vector<acl::VectorOfElements> & values);
51
52
53 }// asl
54
55 #endif // TEMPLATEVEEXTRAS_H_INCLUDED