File: modules.md

package info (click to toggle)
dune-functions 2.10.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,544 kB
  • sloc: cpp: 14,241; python: 661; makefile: 3
file content (66 lines) | stat: -rw-r--r-- 1,978 bytes parent folder | download
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
<!-- -*- tab-width: 4; indent-tabs-mode: nil -*- -->

<!--
SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file AUTHORS.md
SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception OR LGPL-3.0-or-later
-->

# Modules

@defgroup Functions Functions
@brief Interfaces and implementations of functions

Since interfaces in dune-functions rely on duck-typing
there are no base classes to ensure interfaces. Instead
of this each type can be checked, if it satisfies a certain
concept as defined in the Dune::Functions::Concept namespace.
Additionally there is a polymorphic interface consisting
of type-erasure wrappers in the spirit of std::function.

@defgroup FunctionConcepts Function concepts
@ingroup Functions
@brief Concept definitions for function interfaces

@defgroup FunctionInterface Function interface wrappers
@ingroup Functions
@brief Type-erasure based polymorphic wrappers

@defgroup FunctionImplementations Function implementations
@ingroup Functions
@brief Concrete function implementations

@defgroup FunctionUtility Function related utilities
@ingroup Functions
@brief Helper classes and functions related to functions



@defgroup FunctionSpaceBases Function space bases
@brief Interfaces and implementation of global bases for grid function space

@defgroup FunctionSpaceBasesConcepts Function space basis concepts
@ingroup FunctionSpaceBases
@brief Concept definitions and checks related to global bases

@defgroup FunctionSpaceBasesImplementations Function space basis implementations
@ingroup FunctionSpaceBases
@brief Implementations of the GlobalBasis concept

@defgroup FunctionSpaceBasesUtilities Function space basis utilities
@ingroup FunctionSpaceBases
@brief Utilities for implementing and using global bases



@defgroup Utility Utility
@brief Various helper classes and functions

@defgroup TypeErasure Utilities for type-erasure
@brief Helper classes for implementing type-erased interfaces
@ingroup Utility