CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
internalStatementRecordingTapeInterface.hpp
1/*
2 * CoDiPack, a Code Differentiation Package
3 *
4 * Copyright (C) 2015-2024 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
5 * Homepage: http://www.scicomp.uni-kl.de
6 * Contact: Prof. Nicolas R. Gauger (codi@scicomp.uni-kl.de)
7 *
8 * Lead developers: Max Sagebaum, Johannes Blühdorn (SciComp, University of Kaiserslautern-Landau)
9 *
10 * This file is part of CoDiPack (http://www.scicomp.uni-kl.de/software/codi).
11 *
12 * CoDiPack is free software: you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, either version 3 of the
15 * License, or (at your option) any later version.
16 *
17 * CoDiPack is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty
19 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
20 *
21 * See the GNU General Public License for more details.
22 * You should have received a copy of the GNU
23 * General Public License along with CoDiPack.
24 * If not, see <http://www.gnu.org/licenses/>.
25 *
26 * For other licensing options please contact us.
27 *
28 * Authors:
29 * - SciComp, University of Kaiserslautern-Landau:
30 * - Max Sagebaum
31 * - Johannes Blühdorn
32 * - Former members:
33 * - Tim Albring
34 */
35#pragma once
36
37#include "../../config.h"
38#include "../../misc/macros.hpp"
39
41namespace codi {
42
64 template<typename T_Identifier>
66 public:
67
68 using Identifier = CODI_DD(T_Identifier, int);
69
70 /*******************************************************************************/
72
73 static bool constexpr AllowJacobianOptimization =
75
76 template<typename Real>
77 void initIdentifier(Real& value,
78 Identifier& identifier);
80 template<typename Real>
81 void destroyIdentifier(Real& value, Identifier& identifier);
82
92 template<typename Lhs, typename Rhs>
93 void store(Lhs& lhs, Rhs const& rhs);
94 };
95}
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition: macros.hpp:94
#define CODI_UNDEFINED_VALUE
Used in interface declarations for variables that have to be defined in the specializations.
Definition: macros.hpp:117
CoDiPack - Code Differentiation Package.
Definition: codi.hpp:90
Represents a concrete lvalue in the CoDiPack expression tree.
Definition: activeType.hpp:52
Internal tape interface that is used by active types to trigger the storing of an expression.
Definition: internalStatementRecordingTapeInterface.hpp:65
void destroyIdentifier(Real &value, Identifier &identifier)
Has to be called for each identifier, before it is deallocated.
T_Identifier Identifier
See InternalStatementRecordingTapeInterface.
Definition: internalStatementRecordingTapeInterface.hpp:68
void store(Lhs &lhs, Rhs const &rhs)
Has to be called by an AD variable every time it is assigned.
void initIdentifier(Real &value, Identifier &identifier)
static bool constexpr AllowJacobianOptimization
If certain operations can be hidden from the tape.
Definition: internalStatementRecordingTapeInterface.hpp:73