DUNE-FUNCTIONS (unstable)

defaultglobalbasis.hh
1// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
2// vi: set et ts=4 sw=2 sts=2:
3
4// SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file AUTHORS.md
5// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception OR LGPL-3.0-or-later
6
7#ifndef DUNE_FUNCTIONS_FUNCTIONSPACEBASES_DEFAULTGLOBALBASIS_HH
8#define DUNE_FUNCTIONS_FUNCTIONSPACEBASES_DEFAULTGLOBALBASIS_HH
9
10#include <cstddef>
11#include <type_traits>
12#include <utility>
13
14#include <dune/common/reservedvector.hh>
15#include <dune/common/typeutilities.hh>
16#include <dune/common/concept.hh>
17
18#include <dune/functions/common/type_traits.hh>
19#include <dune/functions/functionspacebases/defaultlocalview.hh>
20#include <dune/functions/functionspacebases/concepts.hh>
21
22
23
24namespace Dune {
25namespace Functions {
26
27
28
48template<class PB>
50{
51
52public:
53
55 using PreBasis = PB;
56
58 using PrefixPath = TypeTree::HybridTreePath<>;
59
61 using GridView = typename PreBasis::GridView;
62
64 using size_type = std::size_t;
65
68
71
73 using SizePrefix = Dune::ReservedVector<std::size_t, PreBasis::multiIndexBufferSize>;
74
83 template<class... T,
84 disableCopyMove<DefaultGlobalBasis, T...> = 0,
87 preBasis_(std::forward<T>(t)...),
88 prefixPath_()
89 {
90 static_assert(models<Concept::PreBasis<GridView>, PreBasis>(), "Type passed to DefaultGlobalBasis does not model the PreBasis concept.");
91 preBasis_.initializeIndices();
92 }
93
100 template<class PreBasisFactory,
101 std::enable_if_t<Dune::IsCallable<PreBasisFactory(GridView), PreBasis>::value, int> = 0>
102 DefaultGlobalBasis(const GridView& gridView, PreBasisFactory&& factory) :
103 preBasis_(factory(gridView)),
104 prefixPath_()
105 {
106 static_assert(models<Concept::PreBasis<GridView>, PreBasis>(), "Type passed to DefaultGlobalBasis does not model the PreBasis concept.");
107 preBasis_.initializeIndices();
108 }
109
111 const GridView& gridView() const
112 {
113 return preBasis_.gridView();
114 }
115
117 const PreBasis& preBasis() const
118 {
119 return preBasis_;
120 }
121
124 {
125 return preBasis_;
126 }
127
134 void update(const GridView & gv)
135 {
136 preBasis_.update(gv);
137 preBasis_.initializeIndices();
138 }
139
142 {
143 return preBasis_.dimension();
144 }
145
148 {
149 return preBasis_.size();
150 }
151
153 size_type size(const SizePrefix& prefix) const
154 {
155 return preBasis_.size(prefix);
156 }
157
160 {
161 return LocalView(*this);
162 }
163
166 {
167 return *this;
168 }
169
171 const PrefixPath& prefixPath() const
172 {
173 return prefixPath_;
174 }
175
176protected:
177 PreBasis preBasis_;
178 PrefixPath prefixPath_;
179};
180
181
182
183template<class PreBasis>
184DefaultGlobalBasis(PreBasis&&) -> DefaultGlobalBasis<std::decay_t<PreBasis>>;
185
186template<class GridView, class PreBasisFactory>
187DefaultGlobalBasis(const GridView& gv, PreBasisFactory&& f) -> DefaultGlobalBasis<std::decay_t<decltype(f(gv))>>;
188
189
190
191namespace BasisFactory {
192
193template<class GridView, class PreBasisFactory>
194auto makeBasis(const GridView& gridView, PreBasisFactory&& preBasisFactory)
195{
196 return DefaultGlobalBasis(preBasisFactory(gridView));
197}
198
199} // end namespace BasisFactory
200
201// Backward compatibility
202namespace [[deprecated("Will be removed after Dune 2.10")]] BasisBuilder {
203
204 using namespace BasisFactory;
205
206}
207
208
209} // end namespace Functions
210} // end namespace Dune
211
212
213
214#endif // DUNE_FUNCTIONS_FUNCTIONSPACEBASES_DEFAULTGLOBALBASIS_HH
Global basis for given pre-basis.
Definition: defaultglobalbasis.hh:50
Dune::ReservedVector< std::size_t, PreBasis::multiIndexBufferSize > SizePrefix
Type used for prefixes handed to the size() method.
Definition: defaultglobalbasis.hh:73
std::size_t size_type
Type used for indices and size information.
Definition: defaultglobalbasis.hh:64
typename PreBasis::GridView GridView
The grid view that the FE space is defined on.
Definition: defaultglobalbasis.hh:61
const GridView & gridView() const
Obtain the grid view that the basis is defined on.
Definition: defaultglobalbasis.hh:111
PB PreBasis
Pre-basis providing the implementation details.
Definition: defaultglobalbasis.hh:55
PreBasis & preBasis()
Obtain the pre-basis providing the implementation details.
Definition: defaultglobalbasis.hh:123
void update(const GridView &gv)
Update the stored grid view.
Definition: defaultglobalbasis.hh:134
DefaultLocalView< DefaultGlobalBasis< PreBasis > > LocalView
Type of the local view on the restriction of the basis to a single element.
Definition: defaultglobalbasis.hh:67
typename LocalView::MultiIndex MultiIndex
Type used for global numbering of the basis vectors.
Definition: defaultglobalbasis.hh:70
size_type size(const SizePrefix &prefix) const
Return number of possible values for next position in multi index.
Definition: defaultglobalbasis.hh:153
size_type dimension() const
Get the total dimension of the space spanned by this basis.
Definition: defaultglobalbasis.hh:141
LocalView localView() const
Return local view for basis.
Definition: defaultglobalbasis.hh:159
TypeTree::HybridTreePath<> PrefixPath
The empty prefix path that identifies the root in the local ansatz tree.
Definition: defaultglobalbasis.hh:58
DefaultGlobalBasis(T &&... t)
Constructor.
Definition: defaultglobalbasis.hh:86
DefaultGlobalBasis(const GridView &gridView, PreBasisFactory &&factory)
Constructor from a PreBasis factory.
Definition: defaultglobalbasis.hh:102
size_type size() const
Return number of possible values for next position in empty multi index.
Definition: defaultglobalbasis.hh:147
const PreBasis & preBasis() const
Obtain the pre-basis providing the implementation details.
Definition: defaultglobalbasis.hh:117
const DefaultGlobalBasis & rootBasis() const
Return *this because we are not embedded in a larger basis.
Definition: defaultglobalbasis.hh:165
const PrefixPath & prefixPath() const
Return empty path, because this is the root in the local ansatz tree.
Definition: defaultglobalbasis.hh:171
The restriction of a finite element basis to a single element.
Definition: defaultlocalview.hh:32
std::conditional_t<(PreBasis::minMultiIndexSize==PreBasis::maxMultiIndexSize), StaticMultiIndex< size_type, PreBasis::maxMultiIndexSize >, Dune::ReservedVector< size_type, PreBasis::multiIndexBufferSize > > MultiIndex
Type used for global numbering of the basis vectors.
Definition: defaultlocalview.hh:68
std::enable_if_t< std::is_constructible_v< T, Args... >, int > enableIfConstructible
Helper to constrain forwarding constructors.
Definition: type_traits.hh:31
Definition: polynomial.hh:17
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Aug 13, 22:30, 2024)