![]() |
Reference documentation for deal.II version Git 3041c91f43 2021-03-05 14:58:09 +0100
|
#include <deal.II/fe/fe_series.h>
Public Types | |
using | CoefficientType = typename std::complex< double > |
Public Member Functions | |
Fourier (const std::vector< unsigned int > &n_coefficients_per_direction, const hp::FECollection< dim, spacedim > &fe_collection, const hp::QCollection< dim > &q_collection) | |
Fourier (const unsigned int n_coefficients_per_direction, const hp::FECollection< dim, spacedim > &fe_collection, const hp::QCollection< dim > &q_collection) | |
template<typename Number > | |
void | calculate (const ::Vector< Number > &local_dof_values, const unsigned int cell_active_fe_index, Table< dim, CoefficientType > &fourier_coefficients) |
unsigned int | get_n_coefficients_per_direction (const unsigned int index) const |
void | precalculate_all_transformation_matrices () |
template<class Archive > | |
void | save_transformation_matrices (Archive &ar, const unsigned int version) |
template<class Archive > | |
void | load_transformation_matrices (Archive &ar, const unsigned int version) |
bool | operator== (const Fourier< dim, spacedim > &fourier) const |
template<typename Number > | |
void | calculate (const Vector< Number > &local_dof_values, const unsigned int cell_active_fe_index, Table< dim, CoefficientType > &fourier_coefficients) |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
Subscriptor functionality | |
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class. | |
void | subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const |
void | unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const |
unsigned int | n_subscriptions () const |
template<typename StreamType > | |
void | list_subscribers (StreamType &stream) const |
void | list_subscribers () const |
Static Public Member Functions | |
static ::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
static ::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
Private Attributes | |
const std::vector< unsigned int > | n_coefficients_per_direction |
SmartPointer< const hp::FECollection< dim, spacedim > > | fe_collection |
const hp::QCollection< dim > | q_collection |
Table< dim, Tensor< 1, dim > > | k_vectors |
std::vector< FullMatrix< CoefficientType > > | fourier_transform_matrices |
std::vector< CoefficientType > | unrolled_coefficients |
A class to calculate expansion of a scalar FE field into Fourier series on a reference element. The exponential form of the Fourier series is based on completeness and Hermitian orthogonality of the set of exponential functions \( \phi_{\bf k}({\bf x}) = \exp(2 \pi i\, {\bf k} \cdot {\bf x})\). For example in 1D the L2-orthogonality condition reads
\[ \int_0^1 \phi_k(x) \phi_l^\ast(x) dx=\delta_{kl}. \]
Note that \( \phi_{\bf k} = \phi_{-\bf k}^\ast \).
The arbitrary scalar FE field on the reference element can be expanded in the complete orthogonal exponential basis as
\[ u({\bf x}) = \sum_{\bf k} c_{\bf k} \phi_{\bf k}({\bf x}). \]
From the orthogonality property of the basis, it follows that
\[ c_{\bf k} = \int_{[0,1]^d} u({\bf x}) \phi_{\bf k}^\ast ({\bf x}) d{\bf x}\,. \]
It is this complex-valued expansion coefficients, that are calculated by this class. Note that \( u({\bf x}) = \sum_i u_i N_i({\bf x})\), where \( N_i({\bf x}) \) are real-valued FiniteElement shape functions. Consequently \( c_{\bf k} \equiv c_{-\bf k}^\ast \) and we only need to compute \( c_{\bf k} \) for positive indices \( \bf k \) .
Definition at line 87 of file fe_series.h.
using FESeries::Fourier< dim, spacedim >::CoefficientType = typename std::complex<double> |
Definition at line 90 of file fe_series.h.
FESeries::Fourier< dim, spacedim >::Fourier | ( | const std::vector< unsigned int > & | n_coefficients_per_direction, |
const hp::FECollection< dim, spacedim > & | fe_collection, | ||
const hp::QCollection< dim > & | q_collection | ||
) |
Constructor that initializes all required data structures.
The n_coefficients_per_direction
defines the number of coefficients in each direction, fe_collection
is the hp::FECollection for which expansion will be used and q_collection
is the hp::QCollection used to integrate the expansion for each FiniteElement in fe_collection
.
Definition at line 179 of file fe_series_fourier.cc.
FESeries::Fourier< dim, spacedim >::Fourier | ( | const unsigned int | n_coefficients_per_direction, |
const hp::FECollection< dim, spacedim > & | fe_collection, | ||
const hp::QCollection< dim > & | q_collection | ||
) |
A non-default constructor. The n_coefficients_per_direction
defines the number of modes in each direction, fe_collection
is the hp::FECollection for which expansion will be used and q_collection
is the hp::QCollection used to integrate the expansion for each FiniteElement in fe_collection
.
Definition at line 204 of file fe_series_fourier.cc.
void FESeries::Fourier< dim, spacedim >::calculate | ( | const ::Vector< Number > & | local_dof_values, |
const unsigned int | cell_active_fe_index, | ||
Table< dim, CoefficientType > & | fourier_coefficients | ||
) |
Calculate fourier_coefficients
of the cell vector field given by local_dof_values
corresponding to FiniteElement with cell_active_fe_index
.
unsigned int FESeries::Fourier< dim, spacedim >::get_n_coefficients_per_direction | ( | const unsigned int | index | ) | const |
Return the number of coefficients in each coordinate direction for the finite element associated with index
in the provided hp::FECollection.
Definition at line 254 of file fe_series_fourier.cc.
void FESeries::Fourier< dim, spacedim >::precalculate_all_transformation_matrices | ( | ) |
Calculate all transformation matrices to transfer the finite element solution to the series expansion representation.
These matrices will be generated on demand by calling calculate() and stored for recurring purposes. Usually, this operation consumes a lot of workload. With this function, all matrices will be calculated in advance. This way, we can separate their costly generation from the actual application.
Definition at line 234 of file fe_series_fourier.cc.
void FESeries::Fourier< dim, spacedim >::save_transformation_matrices | ( | Archive & | ar, |
const unsigned int | version | ||
) |
Write all transformation matrices of this object to a stream for the purpose of serialization.
Since any of its transformation matrices has to be generated only once for a given scenario, it is common practice to determine them in advance calling precalculate_all_transformation_matrices() and keep them via serialization.
void FESeries::Fourier< dim, spacedim >::load_transformation_matrices | ( | Archive & | ar, |
const unsigned int | version | ||
) |
Read all transformation matrices from a stream and recover them for this object.
|
inline |
Test for equality of two series expansion objects.
Definition at line 220 of file fe_series_fourier.cc.
void FESeries::Fourier< dim, spacedim >::calculate | ( | const Vector< Number > & | local_dof_values, |
const unsigned int | cell_active_fe_index, | ||
Table< dim, CoefficientType > & | fourier_coefficients | ||
) |
Definition at line 265 of file fe_series_fourier.cc.
|
inherited |
Subscribes a user of the object by storing the pointer validity
. The subscriber may be identified by text supplied as identifier
.
Definition at line 136 of file subscriptor.cc.
|
inherited |
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 156 of file subscriptor.cc.
|
inlineinherited |
Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.
Definition at line 301 of file subscriptor.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 318 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 204 of file subscriptor.cc.
|
inlineinherited |
Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.
This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.
Definition at line 310 of file subscriptor.h.
|
private |
Number of coefficients in each direction for each finite element in the registered hp::FECollection.
Definition at line 181 of file fe_series.h.
|
private |
hp::FECollection for which transformation matrices will be calculated.
Definition at line 186 of file fe_series.h.
|
private |
hp::QCollection used in calculation of transformation matrices.
Definition at line 191 of file fe_series.h.
|
private |
Angular frequencies \( 2 \pi {\bf k} \) .
Definition at line 196 of file fe_series.h.
|
private |
Transformation matrices for each FiniteElement.
Definition at line 201 of file fe_series.h.
|
private |
Auxiliary vector to store unrolled coefficients.
Definition at line 206 of file fe_series.h.