Reference documentation for deal.II version 9.5.0
\(\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// Copyright (C) 1998 - 2023 by the deal.II authors
4//
5// This file is part of the deal.II library.
6//
7// The deal.II library is free software; you can use it, redistribute
8// it, and/or modify it under the terms of the GNU Lesser General
9// Public License as published by the Free Software Foundation; either
10// version 2.1 of the License, or (at your option) any later version.
11// The full text of the license can be found in the file LICENSE.md at
12// the top level directory of deal.II.
13//
14// ---------------------------------------------------------------------
15
16#ifndef dealii_matrix_creator_h
17#define dealii_matrix_creator_h
18
19
20#include <deal.II/base/config.h>
21
22#include <deal.II/base/exceptions.h>
23#include <deal.II/base/function.h>
24
25#include <deal.II/lac/affine_constraints.h>
26
27#include <map>
28
29#ifdef DEAL_II_WITH_PETSC
30# include <petscsys.h>
31#endif
32
33DEAL_II_NAMESPACE_OPEN
34
35
36// forward declarations
37#ifndef DOXYGEN
38template <int dim>
39class Quadrature;
40
41
42template <typename number>
43class Vector;
44template <typename number>
45class SparseMatrix;
46
47template <int dim, int spacedim>
48class Mapping;
49template <int dim, int spacedim>
50DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
51class DoFHandler;
52
53namespace hp
54{
55 template <int>
56 class QCollection;
57 template <int, int>
58 class MappingCollection;
59} // namespace hp
60
61#endif
62
63
196namespace MatrixCreator
197{
217 template <int dim, int spacedim, typename SparseMatrixType>
218 void
219 create_mass_matrix(
220 const Mapping<dim, spacedim> & mapping,
221 const DoFHandler<dim, spacedim> &dof,
222 const Quadrature<dim> & q,
223 SparseMatrixType & matrix,
224 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
225 nullptr,
226 const AffineConstraints<typename SparseMatrixType::value_type> &
227 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
228
233 template <int dim, int spacedim, typename SparseMatrixType>
234 void
235 create_mass_matrix(
236 const DoFHandler<dim, spacedim> &dof,
237 const Quadrature<dim> & q,
238 SparseMatrixType & matrix,
239 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
240 nullptr,
241 const AffineConstraints<typename SparseMatrixType::value_type> &
242 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
243
263 template <int dim, int spacedim, typename SparseMatrixType>
264 void
265 create_mass_matrix(
266 const Mapping<dim, spacedim> & mapping,
267 const DoFHandler<dim, spacedim> & dof,
268 const Quadrature<dim> & q,
269 SparseMatrixType & matrix,
270 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
271 Vector<typename SparseMatrixType::value_type> & rhs_vector,
272 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
273 nullptr,
274 const AffineConstraints<typename SparseMatrixType::value_type> &
275 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
276
281 template <int dim, int spacedim, typename SparseMatrixType>
282 void
283 create_mass_matrix(
284 const DoFHandler<dim, spacedim> & dof,
285 const Quadrature<dim> & q,
286 SparseMatrixType & matrix,
287 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
288 Vector<typename SparseMatrixType::value_type> & rhs_vector,
289 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
290 nullptr,
291 const AffineConstraints<typename SparseMatrixType::value_type> &
292 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
293
297 template <int dim, int spacedim, typename SparseMatrixType>
298 void
299 create_mass_matrix(
300 const hp::MappingCollection<dim, spacedim> &mapping,
301 const DoFHandler<dim, spacedim> & dof,
302 const hp::QCollection<dim> & q,
303 SparseMatrixType & matrix,
304 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
305 nullptr,
306 const AffineConstraints<typename SparseMatrixType::value_type> &
307 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
308
312 template <int dim, int spacedim, typename SparseMatrixType>
313 void
314 create_mass_matrix(
315 const DoFHandler<dim, spacedim> &dof,
316 const hp::QCollection<dim> & q,
317 SparseMatrixType & matrix,
318 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
319 nullptr,
320 const AffineConstraints<typename SparseMatrixType::value_type> &
321 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
322
326 template <int dim, int spacedim, typename SparseMatrixType>
327 void
328 create_mass_matrix(
329 const hp::MappingCollection<dim, spacedim> & mapping,
330 const DoFHandler<dim, spacedim> & dof,
331 const hp::QCollection<dim> & q,
332 SparseMatrixType & matrix,
333 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
334 Vector<typename SparseMatrixType::value_type> & rhs_vector,
335 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
336 nullptr,
337 const AffineConstraints<typename SparseMatrixType::value_type> &
338 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
339
343 template <int dim, int spacedim, typename SparseMatrixType>
344 void
345 create_mass_matrix(
346 const DoFHandler<dim, spacedim> & dof,
347 const hp::QCollection<dim> & q,
348 SparseMatrixType & matrix,
349 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
350 Vector<typename SparseMatrixType::value_type> & rhs_vector,
351 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
352 nullptr,
353 const AffineConstraints<typename SparseMatrixType::value_type> &
354 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
355
356
382 template <int dim, int spacedim, typename number>
383 void
384 create_boundary_mass_matrix(
385 const Mapping<dim, spacedim> & mapping,
386 const DoFHandler<dim, spacedim> &dof,
387 const Quadrature<dim - 1> & q,
388 SparseMatrix<number> & matrix,
389 const std::map<types::boundary_id, const Function<spacedim, number> *>
390 & boundary_functions,
391 Vector<number> & rhs_vector,
392 std::vector<types::global_dof_index> & dof_to_boundary_mapping,
393 const Function<spacedim, number> *const weight = 0,
394 std::vector<unsigned int> component_mapping = {});
395
396
401 template <int dim, int spacedim, typename number>
402 void
403 create_boundary_mass_matrix(
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 a = nullptr,
412 std::vector<unsigned int> component_mapping = {});
413
417 template <int dim, int spacedim, typename number>
418 void
419 create_boundary_mass_matrix(
420 const hp::MappingCollection<dim, spacedim> &mapping,
421 const DoFHandler<dim, spacedim> & dof,
422 const hp::QCollection<dim - 1> & q,
423 SparseMatrix<number> & matrix,
424 const std::map<types::boundary_id, const Function<spacedim, number> *>
425 & boundary_functions,
426 Vector<number> & rhs_vector,
427 std::vector<types::global_dof_index> & dof_to_boundary_mapping,
428 const Function<spacedim, number> *const a = nullptr,
429 std::vector<unsigned int> component_mapping = {});
430
434 template <int dim, int spacedim, typename number>
435 void
436 create_boundary_mass_matrix(
437 const DoFHandler<dim, spacedim> &dof,
438 const hp::QCollection<dim - 1> & q,
439 SparseMatrix<number> & matrix,
440 const std::map<types::boundary_id, const Function<spacedim, number> *>
441 & boundary_functions,
442 Vector<number> & rhs_vector,
443 std::vector<types::global_dof_index> & dof_to_boundary_mapping,
444 const Function<spacedim, number> *const a = nullptr,
445 std::vector<unsigned int> component_mapping = {});
446
466 template <int dim, int spacedim, typename SparseMatrixType>
467 void
468 create_laplace_matrix(
469 const Mapping<dim, spacedim> & mapping,
470 const DoFHandler<dim, spacedim> &dof,
471 const Quadrature<dim> & q,
472 SparseMatrixType & matrix,
473 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
474 nullptr,
475 const AffineConstraints<typename SparseMatrixType::value_type> &
476 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
477
482 template <int dim, int spacedim, typename SparseMatrixType>
483 void
484 create_laplace_matrix(
485 const DoFHandler<dim, spacedim> &dof,
486 const Quadrature<dim> & q,
487 SparseMatrixType & matrix,
488 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
489 nullptr,
490 const AffineConstraints<typename SparseMatrixType::value_type> &
491 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
492
511 template <int dim, int spacedim, typename SparseMatrixType>
512 void
513 create_laplace_matrix(
514 const Mapping<dim, spacedim> & mapping,
515 const DoFHandler<dim, spacedim> & dof,
516 const Quadrature<dim> & q,
517 SparseMatrixType & matrix,
518 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
519 Vector<typename SparseMatrixType::value_type> & rhs_vector,
520 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
521 nullptr,
522 const AffineConstraints<typename SparseMatrixType::value_type> &
523 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
524
529 template <int dim, int spacedim, typename SparseMatrixType>
530 void
531 create_laplace_matrix(
532 const DoFHandler<dim, spacedim> & dof,
533 const Quadrature<dim> & q,
534 SparseMatrixType & matrix,
535 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
536 Vector<typename SparseMatrixType::value_type> & rhs_vector,
537 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
538 nullptr,
539 const AffineConstraints<typename SparseMatrixType::value_type> &
540 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
541
545 template <int dim, int spacedim, typename SparseMatrixType>
546 void
547 create_laplace_matrix(
548 const hp::MappingCollection<dim, spacedim> &mapping,
549 const DoFHandler<dim, spacedim> & dof,
550 const hp::QCollection<dim> & q,
551 SparseMatrixType & matrix,
552 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
553 nullptr,
554 const AffineConstraints<typename SparseMatrixType::value_type> &
555 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
556
560 template <int dim, int spacedim, typename SparseMatrixType>
561 void
562 create_laplace_matrix(
563 const DoFHandler<dim, spacedim> &dof,
564 const hp::QCollection<dim> & q,
565 SparseMatrixType & matrix,
566 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
567 nullptr,
568 const AffineConstraints<typename SparseMatrixType::value_type> &
569 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
570
574 template <int dim, int spacedim, typename SparseMatrixType>
575 void
576 create_laplace_matrix(
577 const hp::MappingCollection<dim, spacedim> & mapping,
578 const DoFHandler<dim, spacedim> & dof,
579 const hp::QCollection<dim> & q,
580 SparseMatrixType & matrix,
581 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
582 Vector<typename SparseMatrixType::value_type> & rhs_vector,
583 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
584 nullptr,
585 const AffineConstraints<typename SparseMatrixType::value_type> &
586 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
587
591 template <int dim, int spacedim, typename SparseMatrixType>
592 void
593 create_laplace_matrix(
594 const DoFHandler<dim, spacedim> & dof,
595 const hp::QCollection<dim> & q,
596 SparseMatrixType & matrix,
597 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
598 Vector<typename SparseMatrixType::value_type> & rhs_vector,
599 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
600 nullptr,
601 const AffineConstraints<typename SparseMatrixType::value_type> &
602 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
603
607 DeclExceptionMsg(ExcComponentMismatch,
608 "You are providing either a right hand side function or a "
609 "coefficient with a number of vector components that is "
610 "inconsistent with the rest of the arguments. If you do "
611 "provide a coefficient or right hand side function, then "
612 "it either needs to have as many components as the finite "
613 "element in use, or only a single vector component. In "
614 "the latter case, the same value will be taken for "
615 "each vector component of the finite element.");
616} // namespace MatrixCreator
617
618
619DEAL_II_NAMESPACE_CLOSE
620
621#endif
affine_constraints.h
Mapping
Abstract base class for mapping classes.
Definition mapping.h:317
concepts::is_valid_dim_spacedim
Definition template_constraints.h:720
DEAL_II_NAMESPACE_OPEN
#define DEAL_II_NAMESPACE_OPEN
Definition config.h:472
DEAL_II_CXX20_REQUIRES
#define DEAL_II_CXX20_REQUIRES(condition)
Definition config.h:160
DEAL_II_NAMESPACE_CLOSE
#define DEAL_II_NAMESPACE_CLOSE
Definition config.h:473
DeclExceptionMsg
#define DeclExceptionMsg(Exception, defaulttext)
Definition exceptions.h:488
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, SparseMatrixType &matrix, const Function< spacedim, typename SparseMatrixType::value_type > *const a=nullptr, const AffineConstraints< typename SparseMatrixType::value_type > &constraints=AffineConstraints< typename SparseMatrixType::value_type >())
MatrixCreator::create_laplace_matrix
void create_laplace_matrix(const Mapping< dim, spacedim > &mapping, const DoFHandler< dim, spacedim > &dof, const Quadrature< dim > &q, SparseMatrixType &matrix, const Function< spacedim, typename SparseMatrixType::value_type > *const a=nullptr, const AffineConstraints< typename SparseMatrixType::value_type > &constraints=AffineConstraints< typename SparseMatrixType::value_type >())
hp
Definition hp.h:118
Generated by doxygen 1.9.7