deal.II version GIT relicensing-6834-g5b78e6bcdf 2026-10-01 11:20:01+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
matrix_creator.h
Go to the documentation of this file.
1// -----------------------------------------------------------------------------
2//
3// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
4// Copyright (C) 1998 - 2025 by the deal.II authors
5//
6// This file is part of the deal.II library.
7//
8// Detailed license information governing the source code and contributions
9// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
10//
11// -----------------------------------------------------------------------------
12
13#ifndef dealii_matrix_creator_h
14#define dealii_matrix_creator_h
15
16
17#include <deal.II/base/config.h>
18
19#include <deal.II/base/exceptions.h>
20#include <deal.II/base/function.h>
21
22#include <deal.II/lac/affine_constraints.h>
23
24#include <map>
25
26#ifdef DEAL_II_WITH_PETSC
27# include <petscsys.h>
28#endif
29
30DEAL_II_NAMESPACE_OPEN
31
32
33// forward declarations
34#ifndef DOXYGEN
35template <int dim>
36class Quadrature;
37
38
39template <typename number>
40class Vector;
41template <typename number>
42class SparseMatrix;
43
44template <int dim, int spacedim>
45class Mapping;
46template <int dim, int spacedim>
47DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
48class DoFHandler;
49
50namespace hp
51{
52 template <int>
53 class QCollection;
54 template <int, int>
55 class MappingCollection;
56} // namespace hp
57
58#endif
59
60
193namespace MatrixCreator
194{
214 template <int dim, int spacedim, typename MatrixType>
215 void
216 create_mass_matrix(
217 const Mapping<dim, spacedim> &mapping,
218 const DoFHandler<dim, spacedim> &dof,
219 const Quadrature<dim> &q,
220 MatrixType &matrix,
221 const Function<spacedim, typename MatrixType::value_type> *const a =
222 nullptr,
223 const AffineConstraints<typename MatrixType::value_type> &constraints =
224 AffineConstraints<typename MatrixType::value_type>());
225
230 template <int dim, int spacedim, typename MatrixType>
231 void
232 create_mass_matrix(
233 const DoFHandler<dim, spacedim> &dof,
234 const Quadrature<dim> &q,
235 MatrixType &matrix,
236 const Function<spacedim, typename MatrixType::value_type> *const a =
237 nullptr,
238 const AffineConstraints<typename MatrixType::value_type> &constraints =
239 AffineConstraints<typename MatrixType::value_type>());
240
260 template <int dim, int spacedim, typename MatrixType>
261 void
262 create_mass_matrix(
263 const Mapping<dim, spacedim> &mapping,
264 const DoFHandler<dim, spacedim> &dof,
265 const Quadrature<dim> &q,
266 MatrixType &matrix,
267 const Function<spacedim, typename MatrixType::value_type> &rhs,
268 Vector<typename MatrixType::value_type> &rhs_vector,
269 const Function<spacedim, typename MatrixType::value_type> *const a =
270 nullptr,
271 const AffineConstraints<typename MatrixType::value_type> &constraints =
272 AffineConstraints<typename MatrixType::value_type>());
273
278 template <int dim, int spacedim, typename MatrixType>
279 void
280 create_mass_matrix(
281 const DoFHandler<dim, spacedim> &dof,
282 const Quadrature<dim> &q,
283 MatrixType &matrix,
284 const Function<spacedim, typename MatrixType::value_type> &rhs,
285 Vector<typename MatrixType::value_type> &rhs_vector,
286 const Function<spacedim, typename MatrixType::value_type> *const a =
287 nullptr,
288 const AffineConstraints<typename MatrixType::value_type> &constraints =
289 AffineConstraints<typename MatrixType::value_type>());
290
294 template <int dim, int spacedim, typename MatrixType>
295 void
296 create_mass_matrix(
297 const hp::MappingCollection<dim, spacedim> &mapping,
298 const DoFHandler<dim, spacedim> &dof,
299 const hp::QCollection<dim> &q,
300 MatrixType &matrix,
301 const Function<spacedim, typename MatrixType::value_type> *const a =
302 nullptr,
303 const AffineConstraints<typename MatrixType::value_type> &constraints =
304 AffineConstraints<typename MatrixType::value_type>());
305
309 template <int dim, int spacedim, typename MatrixType>
310 void
311 create_mass_matrix(
312 const DoFHandler<dim, spacedim> &dof,
313 const hp::QCollection<dim> &q,
314 MatrixType &matrix,
315 const Function<spacedim, typename MatrixType::value_type> *const a =
316 nullptr,
317 const AffineConstraints<typename MatrixType::value_type> &constraints =
318 AffineConstraints<typename MatrixType::value_type>());
319
323 template <int dim, int spacedim, typename MatrixType>
324 void
325 create_mass_matrix(
326 const hp::MappingCollection<dim, spacedim> &mapping,
327 const DoFHandler<dim, spacedim> &dof,
328 const hp::QCollection<dim> &q,
329 MatrixType &matrix,
330 const Function<spacedim, typename MatrixType::value_type> &rhs,
331 Vector<typename MatrixType::value_type> &rhs_vector,
332 const Function<spacedim, typename MatrixType::value_type> *const a =
333 nullptr,
334 const AffineConstraints<typename MatrixType::value_type> &constraints =
335 AffineConstraints<typename MatrixType::value_type>());
336
340 template <int dim, int spacedim, typename MatrixType>
341 void
342 create_mass_matrix(
343 const DoFHandler<dim, spacedim> &dof,
344 const hp::QCollection<dim> &q,
345 MatrixType &matrix,
346 const Function<spacedim, typename MatrixType::value_type> &rhs,
347 Vector<typename MatrixType::value_type> &rhs_vector,
348 const Function<spacedim, typename MatrixType::value_type> *const a =
349 nullptr,
350 const AffineConstraints<typename MatrixType::value_type> &constraints =
351 AffineConstraints<typename MatrixType::value_type>());
352
353
400 template <int dim, int spacedim, typename number>
401 void
402 create_boundary_mass_matrix(
403 const Mapping<dim, spacedim> &mapping,
404 const DoFHandler<dim, spacedim> &dof,
405 const Quadrature<dim - 1> &q,
406 SparseMatrix<number> &matrix,
407 const std::map<types::boundary_id, const Function<spacedim, number> *>
408 &boundary_functions,
409 Vector<number> &rhs_vector,
410 std::vector<types::global_dof_index> &dof_to_boundary_mapping,
411 const Function<spacedim, number> *const weight = 0,
412 std::vector<unsigned int> component_mapping = {});
413
414
419 template <int dim, int spacedim, typename number>
420 void
421 create_boundary_mass_matrix(
422 const DoFHandler<dim, spacedim> &dof,
423 const Quadrature<dim - 1> &q,
424 SparseMatrix<number> &matrix,
425 const std::map<types::boundary_id, const Function<spacedim, number> *>
426 &boundary_functions,
427 Vector<number> &rhs_vector,
428 std::vector<types::global_dof_index> &dof_to_boundary_mapping,
429 const Function<spacedim, number> *const a = nullptr,
430 std::vector<unsigned int> component_mapping = {});
431
435 template <int dim, int spacedim, typename number>
436 void
437 create_boundary_mass_matrix(
438 const hp::MappingCollection<dim, spacedim> &mapping,
439 const DoFHandler<dim, spacedim> &dof,
440 const hp::QCollection<dim - 1> &q,
441 SparseMatrix<number> &matrix,
442 const std::map<types::boundary_id, const Function<spacedim, number> *>
443 &boundary_functions,
444 Vector<number> &rhs_vector,
445 std::vector<types::global_dof_index> &dof_to_boundary_mapping,
446 const Function<spacedim, number> *const a = nullptr,
447 std::vector<unsigned int> component_mapping = {});
448
452 template <int dim, int spacedim, typename number>
453 void
454 create_boundary_mass_matrix(
455 const DoFHandler<dim, spacedim> &dof,
456 const hp::QCollection<dim - 1> &q,
457 SparseMatrix<number> &matrix,
458 const std::map<types::boundary_id, const Function<spacedim, number> *>
459 &boundary_functions,
460 Vector<number> &rhs_vector,
461 std::vector<types::global_dof_index> &dof_to_boundary_mapping,
462 const Function<spacedim, number> *const a = nullptr,
463 std::vector<unsigned int> component_mapping = {});
464
484 template <int dim, int spacedim, typename MatrixType>
485 void
486 create_laplace_matrix(
487 const Mapping<dim, spacedim> &mapping,
488 const DoFHandler<dim, spacedim> &dof,
489 const Quadrature<dim> &q,
490 MatrixType &matrix,
491 const Function<spacedim, typename MatrixType::value_type> *const a =
492 nullptr,
493 const AffineConstraints<typename MatrixType::value_type> &constraints =
494 AffineConstraints<typename MatrixType::value_type>());
495
500 template <int dim, int spacedim, typename MatrixType>
501 void
502 create_laplace_matrix(
503 const DoFHandler<dim, spacedim> &dof,
504 const Quadrature<dim> &q,
505 MatrixType &matrix,
506 const Function<spacedim, typename MatrixType::value_type> *const a =
507 nullptr,
508 const AffineConstraints<typename MatrixType::value_type> &constraints =
509 AffineConstraints<typename MatrixType::value_type>());
510
529 template <int dim, int spacedim, typename MatrixType>
530 void
531 create_laplace_matrix(
532 const Mapping<dim, spacedim> &mapping,
533 const DoFHandler<dim, spacedim> &dof,
534 const Quadrature<dim> &q,
535 MatrixType &matrix,
536 const Function<spacedim, typename MatrixType::value_type> &rhs,
537 Vector<typename MatrixType::value_type> &rhs_vector,
538 const Function<spacedim, typename MatrixType::value_type> *const a =
539 nullptr,
540 const AffineConstraints<typename MatrixType::value_type> &constraints =
541 AffineConstraints<typename MatrixType::value_type>());
542
547 template <int dim, int spacedim, typename MatrixType>
548 void
549 create_laplace_matrix(
550 const DoFHandler<dim, spacedim> &dof,
551 const Quadrature<dim> &q,
552 MatrixType &matrix,
553 const Function<spacedim, typename MatrixType::value_type> &rhs,
554 Vector<typename MatrixType::value_type> &rhs_vector,
555 const Function<spacedim, typename MatrixType::value_type> *const a =
556 nullptr,
557 const AffineConstraints<typename MatrixType::value_type> &constraints =
558 AffineConstraints<typename MatrixType::value_type>());
559
563 template <int dim, int spacedim, typename MatrixType>
564 void
565 create_laplace_matrix(
566 const hp::MappingCollection<dim, spacedim> &mapping,
567 const DoFHandler<dim, spacedim> &dof,
568 const hp::QCollection<dim> &q,
569 MatrixType &matrix,
570 const Function<spacedim, typename MatrixType::value_type> *const a =
571 nullptr,
572 const AffineConstraints<typename MatrixType::value_type> &constraints =
573 AffineConstraints<typename MatrixType::value_type>());
574
578 template <int dim, int spacedim, typename MatrixType>
579 void
580 create_laplace_matrix(
581 const DoFHandler<dim, spacedim> &dof,
582 const hp::QCollection<dim> &q,
583 MatrixType &matrix,
584 const Function<spacedim, typename MatrixType::value_type> *const a =
585 nullptr,
586 const AffineConstraints<typename MatrixType::value_type> &constraints =
587 AffineConstraints<typename MatrixType::value_type>());
588
592 template <int dim, int spacedim, typename MatrixType>
593 void
594 create_laplace_matrix(
595 const hp::MappingCollection<dim, spacedim> &mapping,
596 const DoFHandler<dim, spacedim> &dof,
597 const hp::QCollection<dim> &q,
598 MatrixType &matrix,
599 const Function<spacedim, typename MatrixType::value_type> &rhs,
600 Vector<typename MatrixType::value_type> &rhs_vector,
601 const Function<spacedim, typename MatrixType::value_type> *const a =
602 nullptr,
603 const AffineConstraints<typename MatrixType::value_type> &constraints =
604 AffineConstraints<typename MatrixType::value_type>());
605
609 template <int dim, int spacedim, typename MatrixType>
610 void
611 create_laplace_matrix(
612 const DoFHandler<dim, spacedim> &dof,
613 const hp::QCollection<dim> &q,
614 MatrixType &matrix,
615 const Function<spacedim, typename MatrixType::value_type> &rhs,
616 Vector<typename MatrixType::value_type> &rhs_vector,
617 const Function<spacedim, typename MatrixType::value_type> *const a =
618 nullptr,
619 const AffineConstraints<typename MatrixType::value_type> &constraints =
620 AffineConstraints<typename MatrixType::value_type>());
621
625 DeclExceptionMsg(ExcComponentMismatch,
626 "You are providing either a right hand side function or a "
627 "coefficient with a number of vector components that is "
628 "inconsistent with the rest of the arguments. If you do "
629 "provide a coefficient or right hand side function, then "
630 "it either needs to have as many components as the finite "
631 "element in use, or only a single vector component. In "
632 "the latter case, the same value will be taken for "
633 "each vector component of the finite element.");
634} // namespace MatrixCreator
635
636
637DEAL_II_NAMESPACE_CLOSE
638
639#endif
affine_constraints.h
Mapping
Abstract base class for mapping classes.
Definition mapping.h:318
concepts::is_valid_dim_spacedim
Definition template_constraints.h:712
DEAL_II_NAMESPACE_OPEN
#define DEAL_II_NAMESPACE_OPEN
Definition config.h:38
DEAL_II_CXX20_REQUIRES
#define DEAL_II_CXX20_REQUIRES(condition)
Definition config.h:249
DEAL_II_NAMESPACE_CLOSE
#define DEAL_II_NAMESPACE_CLOSE
Definition config.h:39
DeclExceptionMsg
#define DeclExceptionMsg(Exception, defaulttext)
Definition exception_macros.h:346
MatrixCreator::ExcComponentMismatch
static ::ExceptionBase & ExcComponentMismatch()
MatrixCreator::create_boundary_mass_matrix
void create_boundary_mass_matrix(const Mapping< dim, spacedim > &mapping, const DoFHandler< dim, spacedim > &dof, const Quadrature< dim - 1 > &q, SparseMatrix< number > &matrix, const std::map< types::boundary_id, const Function< spacedim, number > * > &boundary_functions, Vector< number > &rhs_vector, std::vector< types::global_dof_index > &dof_to_boundary_mapping, const Function< spacedim, number > *const weight=0, std::vector< unsigned int > component_mapping={})
MatrixCreator::create_mass_matrix
void create_mass_matrix(const Mapping< dim, spacedim > &mapping, const DoFHandler< dim, spacedim > &dof, const Quadrature< dim > &q, MatrixType &matrix, const Function< spacedim, typename MatrixType::value_type > *const a=nullptr, const AffineConstraints< typename MatrixType::value_type > &constraints=AffineConstraints< typename MatrixType::value_type >())
MatrixCreator::create_laplace_matrix
void create_laplace_matrix(const Mapping< dim, spacedim > &mapping, const DoFHandler< dim, spacedim > &dof, const Quadrature< dim > &q, MatrixType &matrix, const Function< spacedim, typename MatrixType::value_type > *const a=nullptr, const AffineConstraints< typename MatrixType::value_type > &constraints=AffineConstraints< typename MatrixType::value_type >())
hp
Definition hp.h:115
Generated by doxygen 1.9.8