Reference documentation for deal.II version 9.4.1
\(\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 - 2021 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>
50class DoFHandler;
51
52namespace hp
53{
54 template <int>
55 class QCollection;
56 template <int, int>
57 class MappingCollection;
58} // namespace hp
59
60#endif
61
62
195namespace MatrixCreator
196{
216 template <int dim, int spacedim, typename SparseMatrixType>
217 void
218 create_mass_matrix(
219 const Mapping<dim, spacedim> & mapping,
220 const DoFHandler<dim, spacedim> &dof,
221 const Quadrature<dim> & q,
222 SparseMatrixType & matrix,
223 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
224 nullptr,
225 const AffineConstraints<typename SparseMatrixType::value_type> &
226 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
227
232 template <int dim, int spacedim, typename SparseMatrixType>
233 void
234 create_mass_matrix(
235 const DoFHandler<dim, spacedim> &dof,
236 const Quadrature<dim> & q,
237 SparseMatrixType & matrix,
238 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
239 nullptr,
240 const AffineConstraints<typename SparseMatrixType::value_type> &
241 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
242
262 template <int dim, int spacedim, typename SparseMatrixType>
263 void
264 create_mass_matrix(
265 const Mapping<dim, spacedim> & mapping,
266 const DoFHandler<dim, spacedim> & dof,
267 const Quadrature<dim> & q,
268 SparseMatrixType & matrix,
269 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
270 Vector<typename SparseMatrixType::value_type> & rhs_vector,
271 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
272 nullptr,
273 const AffineConstraints<typename SparseMatrixType::value_type> &
274 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
275
280 template <int dim, int spacedim, typename SparseMatrixType>
281 void
282 create_mass_matrix(
283 const DoFHandler<dim, spacedim> & dof,
284 const Quadrature<dim> & q,
285 SparseMatrixType & matrix,
286 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
287 Vector<typename SparseMatrixType::value_type> & rhs_vector,
288 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
289 nullptr,
290 const AffineConstraints<typename SparseMatrixType::value_type> &
291 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
292
296 template <int dim, int spacedim, typename SparseMatrixType>
297 void
298 create_mass_matrix(
299 const hp::MappingCollection<dim, spacedim> &mapping,
300 const DoFHandler<dim, spacedim> & dof,
301 const hp::QCollection<dim> & q,
302 SparseMatrixType & matrix,
303 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
304 nullptr,
305 const AffineConstraints<typename SparseMatrixType::value_type> &
306 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
307
311 template <int dim, int spacedim, typename SparseMatrixType>
312 void
313 create_mass_matrix(
314 const DoFHandler<dim, spacedim> &dof,
315 const hp::QCollection<dim> & q,
316 SparseMatrixType & matrix,
317 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
318 nullptr,
319 const AffineConstraints<typename SparseMatrixType::value_type> &
320 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
321
325 template <int dim, int spacedim, typename SparseMatrixType>
326 void
327 create_mass_matrix(
328 const hp::MappingCollection<dim, spacedim> & mapping,
329 const DoFHandler<dim, spacedim> & dof,
330 const hp::QCollection<dim> & q,
331 SparseMatrixType & matrix,
332 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
333 Vector<typename SparseMatrixType::value_type> & rhs_vector,
334 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
335 nullptr,
336 const AffineConstraints<typename SparseMatrixType::value_type> &
337 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
338
342 template <int dim, int spacedim, typename SparseMatrixType>
343 void
344 create_mass_matrix(
345 const DoFHandler<dim, spacedim> & dof,
346 const hp::QCollection<dim> & q,
347 SparseMatrixType & matrix,
348 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
349 Vector<typename SparseMatrixType::value_type> & rhs_vector,
350 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
351 nullptr,
352 const AffineConstraints<typename SparseMatrixType::value_type> &
353 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
354
355
381 template <int dim, int spacedim, typename number>
382 void
383 create_boundary_mass_matrix(
384 const Mapping<dim, spacedim> & mapping,
385 const DoFHandler<dim, spacedim> &dof,
386 const Quadrature<dim - 1> & q,
387 SparseMatrix<number> & matrix,
388 const std::map<types::boundary_id, const Function<spacedim, number> *>
389 & boundary_functions,
390 Vector<number> & rhs_vector,
391 std::vector<types::global_dof_index> & dof_to_boundary_mapping,
392 const Function<spacedim, number> *const weight = 0,
393 std::vector<unsigned int> component_mapping = {});
394
395
400 template <int dim, int spacedim, typename number>
401 void
402 create_boundary_mass_matrix(
403 const DoFHandler<dim, spacedim> &dof,
404 const Quadrature<dim - 1> & q,
405 SparseMatrix<number> & matrix,
406 const std::map<types::boundary_id, const Function<spacedim, number> *>
407 & boundary_functions,
408 Vector<number> & rhs_vector,
409 std::vector<types::global_dof_index> & dof_to_boundary_mapping,
410 const Function<spacedim, number> *const a = nullptr,
411 std::vector<unsigned int> component_mapping = {});
412
416 template <int dim, int spacedim, typename number>
417 void
418 create_boundary_mass_matrix(
419 const hp::MappingCollection<dim, spacedim> &mapping,
420 const DoFHandler<dim, spacedim> & dof,
421 const hp::QCollection<dim - 1> & q,
422 SparseMatrix<number> & matrix,
423 const std::map<types::boundary_id, const Function<spacedim, number> *>
424 & boundary_functions,
425 Vector<number> & rhs_vector,
426 std::vector<types::global_dof_index> & dof_to_boundary_mapping,
427 const Function<spacedim, number> *const a = nullptr,
428 std::vector<unsigned int> component_mapping = {});
429
433 template <int dim, int spacedim, typename number>
434 void
435 create_boundary_mass_matrix(
436 const DoFHandler<dim, spacedim> &dof,
437 const hp::QCollection<dim - 1> & q,
438 SparseMatrix<number> & matrix,
439 const std::map<types::boundary_id, const Function<spacedim, number> *>
440 & boundary_functions,
441 Vector<number> & rhs_vector,
442 std::vector<types::global_dof_index> & dof_to_boundary_mapping,
443 const Function<spacedim, number> *const a = nullptr,
444 std::vector<unsigned int> component_mapping = {});
445
465 template <int dim, int spacedim, typename SparseMatrixType>
466 void
467 create_laplace_matrix(
468 const Mapping<dim, spacedim> & mapping,
469 const DoFHandler<dim, spacedim> &dof,
470 const Quadrature<dim> & q,
471 SparseMatrixType & matrix,
472 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
473 nullptr,
474 const AffineConstraints<typename SparseMatrixType::value_type> &
475 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
476
481 template <int dim, int spacedim, typename SparseMatrixType>
482 void
483 create_laplace_matrix(
484 const DoFHandler<dim, spacedim> &dof,
485 const Quadrature<dim> & q,
486 SparseMatrixType & matrix,
487 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
488 nullptr,
489 const AffineConstraints<typename SparseMatrixType::value_type> &
490 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
491
510 template <int dim, int spacedim, typename SparseMatrixType>
511 void
512 create_laplace_matrix(
513 const Mapping<dim, spacedim> & mapping,
514 const DoFHandler<dim, spacedim> & dof,
515 const Quadrature<dim> & q,
516 SparseMatrixType & matrix,
517 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
518 Vector<typename SparseMatrixType::value_type> & rhs_vector,
519 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
520 nullptr,
521 const AffineConstraints<typename SparseMatrixType::value_type> &
522 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
523
528 template <int dim, int spacedim, typename SparseMatrixType>
529 void
530 create_laplace_matrix(
531 const DoFHandler<dim, spacedim> & dof,
532 const Quadrature<dim> & q,
533 SparseMatrixType & matrix,
534 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
535 Vector<typename SparseMatrixType::value_type> & rhs_vector,
536 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
537 nullptr,
538 const AffineConstraints<typename SparseMatrixType::value_type> &
539 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
540
544 template <int dim, int spacedim, typename SparseMatrixType>
545 void
546 create_laplace_matrix(
547 const hp::MappingCollection<dim, spacedim> &mapping,
548 const DoFHandler<dim, spacedim> & dof,
549 const hp::QCollection<dim> & q,
550 SparseMatrixType & matrix,
551 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
552 nullptr,
553 const AffineConstraints<typename SparseMatrixType::value_type> &
554 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
555
559 template <int dim, int spacedim, typename SparseMatrixType>
560 void
561 create_laplace_matrix(
562 const DoFHandler<dim, spacedim> &dof,
563 const hp::QCollection<dim> & q,
564 SparseMatrixType & matrix,
565 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
566 nullptr,
567 const AffineConstraints<typename SparseMatrixType::value_type> &
568 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
569
573 template <int dim, int spacedim, typename SparseMatrixType>
574 void
575 create_laplace_matrix(
576 const hp::MappingCollection<dim, spacedim> & mapping,
577 const DoFHandler<dim, spacedim> & dof,
578 const hp::QCollection<dim> & q,
579 SparseMatrixType & matrix,
580 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
581 Vector<typename SparseMatrixType::value_type> & rhs_vector,
582 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
583 nullptr,
584 const AffineConstraints<typename SparseMatrixType::value_type> &
585 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
586
590 template <int dim, int spacedim, typename SparseMatrixType>
591 void
592 create_laplace_matrix(
593 const DoFHandler<dim, spacedim> & dof,
594 const hp::QCollection<dim> & q,
595 SparseMatrixType & matrix,
596 const Function<spacedim, typename SparseMatrixType::value_type> &rhs,
597 Vector<typename SparseMatrixType::value_type> & rhs_vector,
598 const Function<spacedim, typename SparseMatrixType::value_type> *const a =
599 nullptr,
600 const AffineConstraints<typename SparseMatrixType::value_type> &
601 constraints = AffineConstraints<typename SparseMatrixType::value_type>());
602
606 DeclExceptionMsg(ExcComponentMismatch,
607 "You are providing either a right hand side function or a "
608 "coefficient with a number of vector components that is "
609 "inconsistent with the rest of the arguments. If you do "
610 "provide a coefficient or right hand side function, then "
611 "it either needs to have as many components as the finite "
612 "element in use, or only a single vector component. In "
613 "the latter case, the same value will be taken for "
614 "each vector component of the finite element.");
615} // namespace MatrixCreator
616
617
618DEAL_II_NAMESPACE_CLOSE
619
620#endif
affine_constraints.h
Mapping
Abstract base class for mapping classes.
Definition: mapping.h:311
Vector
Definition: vector.h:109
DEAL_II_NAMESPACE_OPEN
#define DEAL_II_NAMESPACE_OPEN
Definition: config.h:442
DEAL_II_NAMESPACE_CLOSE
#define DEAL_II_NAMESPACE_CLOSE
Definition: config.h:443
DeclExceptionMsg
#define DeclExceptionMsg(Exception, defaulttext)
Definition: exceptions.h:487
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.5