Commit fbd53506 authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#531 Doxygen comments in Private::Recursivity.

parent dd123b19
......@@ -816,7 +816,6 @@
BEA263B71A28D0FB001802B6 /* libOps.a in Frameworks */ = {isa = PBXBuildFile; fileRef = BE2393141A23977700E24C84 /* libOps.a */; };
BEA263B81A28D0FB001802B6 /* libSeldon.a in Frameworks */ = {isa = PBXBuildFile; fileRef = BE2393191A23978400E24C84 /* libSeldon.a */; };
BEA263B91A28D0FB001802B6 /* Accelerate.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = BEC37E0617DDC0210021BFB7 /* Accelerate.framework */; };
BEA3FA7E1AF10AA000D3F871 /* Recursivity.cpp in Sources */ = {isa = PBXBuildFile; fileRef = BEA3FA7B1AF10AA000D3F871 /* Recursivity.cpp */; };
BEA3FA7F1AF10AA000D3F871 /* Recursivity.hpp in Headers */ = {isa = PBXBuildFile; fileRef = BEA3FA7C1AF10AA000D3F871 /* Recursivity.hpp */; };
BEA3FA801AF10AA000D3F871 /* Recursivity.hxx in Headers */ = {isa = PBXBuildFile; fileRef = BEA3FA7D1AF10AA000D3F871 /* Recursivity.hxx */; };
BEA3FA8C1AF10CFB00D3F871 /* Recursivity.hpp in Headers */ = {isa = PBXBuildFile; fileRef = BEA3FA891AF10CFB00D3F871 /* Recursivity.hpp */; };
......@@ -2150,7 +2149,6 @@
BEA3248717A7E5BA00ADEB73 /* Exception.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Exception.hpp; sourceTree = "<group>"; };
BEA355D617D0971500FB643B /* OpsFunction.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = OpsFunction.hpp; sourceTree = "<group>"; };
BEA355D717D0971500FB643B /* OpsFunction.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = OpsFunction.hxx; sourceTree = "<group>"; };
BEA3FA7B1AF10AA000D3F871 /* Recursivity.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Recursivity.cpp; sourceTree = "<group>"; };
BEA3FA7C1AF10AA000D3F871 /* Recursivity.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Recursivity.hpp; sourceTree = "<group>"; };
BEA3FA7D1AF10AA000D3F871 /* Recursivity.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Recursivity.hxx; sourceTree = "<group>"; };
BEA3FA891AF10CFB00D3F871 /* Recursivity.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Recursivity.hpp; sourceTree = "<group>"; };
......@@ -3308,7 +3306,6 @@
BE4DDE8C1AE1332900D60CCC /* GlobalVariationalOperator.cpp */,
BE4DDE8D1AE1332900D60CCC /* GlobalVariationalOperator.hpp */,
BE4DDE8E1AE1332900D60CCC /* GlobalVariationalOperator.hxx */,
BEA3FA7B1AF10AA000D3F871 /* Recursivity.cpp */,
BEA3FA7C1AF10AA000D3F871 /* Recursivity.hpp */,
BEA3FA7D1AF10AA000D3F871 /* Recursivity.hxx */,
BEA3FA811AF10CD000D3F871 /* Impl */,
......@@ -6342,7 +6339,6 @@
BE90E1461A2491AE00CCAFDE /* Comp1.cpp in Sources */,
BE90E12A1A2491AE00CCAFDE /* Dof.cpp in Sources */,
BEDAC3C71AD7FBB500AA2156 /* NdofHolder.cpp in Sources */,
BEA3FA7E1AF10AA000D3F871 /* Recursivity.cpp in Sources */,
BE90E06E1A2491AE00CCAFDE /* ReduceToProcessorWise.cpp in Sources */,
BE90E0AE1A2491AE00CCAFDE /* InvariantManager.cpp in Sources */,
BE4B47051AE107730078955C /* LocalVariationalOperator.cpp in Sources */,
......
//
// Recursivity.cpp
// HappyHeart
//
// Created by Sebastien Gilles on 29/04/15.
// Copyright (c) 2015 Inria. All rights reserved.
//
#include "FiniteElement/Operators/GlobalVariationalOperator/Private/Recursivity.hpp"
namespace HappyHeart
{
namespace Private
{
} //namespace Private
} // namespace HappyHeart
......@@ -22,11 +22,36 @@ namespace HappyHeart
{
/*!
* \brief Call Petsc's Assembly() function for each item of \a linear_algebra_tuple.
*
* \tparam LinearAlgebraTupleT A tuple that may include either \a GlobalMatrixAndCoefficient (for bilinear
* operators) or \a GlobalVectorAndCoefficient (for linear operators) objects. Some non linear operators
* may include both types of objects; the ordering doesn't matter.
*
* \param[in] linear_algebra_tuple List of global matrices and/or vectors into which the operator is
* assembled. These objects are assumed to be already properly allocated.
*
*/
template<class LinearAlgebraTupleT>
void Assembly(const LinearAlgebraTupleT& linear_algebra_tuple);
/*!
* \brief Perform the actual assembling for each item of \a linear_algebra_tuple.
*
* \tparam LinearAlgebraTupleT A tuple that may include either \a GlobalMatrixAndCoefficient (for bilinear
* operators) or \a GlobalVectorAndCoefficient (for linear operators) objects. Some non linear operators
* may include both types of objects; the ordering doesn't matter.
*
* \param[in] linear_algebra_tuple List of global matrices and/or vectors into which the operator is
* assembled. These objects are assumed to be already properly allocated.
* \param[in] local_felt_space Local finite element space being assembled. Remind a local finite element
* space is the object linked to a geometric element that hold finite elements information.
* \param[in,out] local_operator Local variational operator in charge of the computation of the local
* linear algebra. It also holds the results of these computations, hence its presence here.
*
*/
template<class LinearAlgebraTupleT, class LocalVariationalOperatorT>
void InjectInGlobalLinearAlgebra(const LinearAlgebraTupleT& linear_algebra_tuple,
const LocalFEltSpace& local_felt_space,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment