The basic assembler that can be used for any standard CG scheme with flux and source. More...

#include <common.hh>

Inheritance diagram for DiFfRG::FEMAssembler< Discretization_, Model_ >:

Public Types
using	Discretization = Discretization_

using	Model = Model_

using	NumberType = typename Discretization::NumberType

using	VectorType = typename Discretization::VectorType

using	Components = typename Discretization::Components

Public Types inherited from DiFfRG::AbstractAssembler< Discretization_::VectorType, Discretization_::SparseMatrixType, Discretization_::dim >
using	NumberType

Public Member Functions
	FEMAssembler (Discretization &discretization, Model &model, const JSONValue &json)

virtual IndexSet	get_differential_indices () const override
	Obtain the dofs which contain time derivatives.

virtual void	attach_data_output (DataOutput< dim, VectorType > &data_out, const VectorType &solution, const VectorType &variables, const VectorType &dt_solution=VectorType(), const VectorType &residual=VectorType()) override

const auto &	get_discretization () const

auto &	get_discretization ()

virtual void	reinit () override
	Reinitialize the assembler. This is necessary if the mesh has changed, e.g. after a mesh refinement.

virtual void	rebuild_jacobian_sparsity ()=0

virtual void	set_time (double t) override
	Set the current time. The assembler should usually just forward this to the numerical model.

virtual void	refinement_indicator (Vector< double > &, const VectorType &)=0

virtual void	residual_variables (VectorType &residual, const VectorType &variables, const VectorType &spatial_solution) override

virtual void	jacobian_variables (FullMatrix< NumberType > &jacobian, const VectorType &variables, const VectorType &spatial_solution) override

void	readouts (DataOutput< dim, VectorType > &data_out, const VectorType &solution_global, const VectorType &variables) const

void	extract (std::array< NumberType, Components::count_extractors()> &data, const VectorType &solution_global, const VectorType &variables, bool search_EoM, bool set_EoM, bool postprocess) const

bool	jacobian_extractors (FullMatrix< NumberType > &extractor_jacobian, const VectorType &solution_global, const VectorType &variables)

double	average_time_variable_residual_assembly ()

uint	num_variable_residuals () const

double	average_time_variable_jacobian_assembly ()

uint	num_variable_jacobians () const

Public Member Functions inherited from DiFfRG::AbstractAssembler< Discretization_::VectorType, Discretization_::SparseMatrixType, Discretization_::dim >
virtual void	attach_data_output (DataOutput< dim, VectorType > &data_out, const VectorType &solution, const VectorType &variables=VectorType(), const VectorType &dt_solution=VectorType(), const VectorType &residual=VectorType())=0
	Attach any data output to the DataOutput object provided. This can be used to extract additional data from the solution and write it to the output file. This includes both derivatives and other spatial functions, as well as single values that can be appended to the .csv file.

virtual const get_type::SparsityPattern< SparseMatrixType > &	get_sparsity_pattern_jacobian () const=0
	Obtain the sparsity pattern of the jacobian matrix.

virtual void	reinit_vector (VectorType &vector) const=0
	Reinitialize an arbitrary vector so that it has the correct size and structure.

virtual const SparseMatrixType &	get_mass_matrix () const=0
	Obtain the mass matrix.

virtual void	residual_variables (VectorType &residual, const VectorType &variables, const VectorType &spatial_solution)
	When coupling the spatial discretization to additional variables, this function should calculate the residual for the additional variables.

virtual void	jacobian_variables (FullMatrix< NumberType > &jacobian, const VectorType &variables, const VectorType &spatial_solution)
	When coupling the spatial discretization to additional variables, this function should calculate the jacobian for the additional variables.

void	mass (VectorType &mass, const VectorType &solution_global, NumberType weight)
	Calculates the mass \(m_i(u)\) for an ODE.

virtual void	mass (VectorType &mass, const VectorType &solution_global, const VectorType &solution_global_dot, NumberType weight)=0
	Calculates the mass \(m(u, \partial_t u)\) for a DAE.

void	residual (VectorType &residual, const VectorType &solution_global, NumberType weight, NumberType weight_mass, const VectorType &variables=VectorType())
	Calculates the residual for an ODE.

virtual void	residual (VectorType &residual, const VectorType &solution_global, NumberType weight, const VectorType &solution_global_dot, NumberType weight_mass, const VectorType &variables=VectorType())=0
	Calculates the residual for a DAE.

void	jacobian_mass (SparseMatrixType &jacobian, const VectorType &solution_global, NumberType mass_weight=1.)
	Calculates the jacobian of the mass function for an ODE.

virtual void	jacobian_mass (SparseMatrixType &jacobian, const VectorType &solution_global, const VectorType &solution_global_dot, NumberType alpha=1., NumberType beta=1.)=0
	Calculates the jacobian of the mass function for a DAE.

void	jacobian (SparseMatrixType &jacobian, const VectorType &solution_global, NumberType weight, NumberType mass_weight, const VectorType &variables=VectorType())
	Calculates the jacobian of the residual function for an ODE.

virtual void	jacobian (SparseMatrixType &jacobian, const VectorType &solution_global, NumberType weight, const VectorType &solution_global_dot, NumberType alpha, NumberType beta, const VectorType &variables=VectorType())=0
	Calculates the jacobian of the residual function for a DAE.

Static Public Attributes
static constexpr uint	dim = Discretization::dim

Static Protected Member Functions
template<typename... T>
static constexpr auto	v_tie (T &&...t)

template<typename... T>
static constexpr auto	e_tie (T &&...t)

Protected Attributes
Discretization &	discretization

Model &	model

const FiniteElement< dim > &	fe

const DoFHandler< dim > &	dof_handler

const Mapping< dim > &	mapping

uint	threads

uint	batch_size

DoFHandler< dim >::cell_iterator	EoM_cell

DoFHandler< dim >::cell_iterator	old_EoM_cell

const double	EoM_abs_tol

const uint	EoM_max_iter

Point< dim >	EoM

FullMatrix< NumberType >	extractor_jacobian

FullMatrix< NumberType >	extractor_jacobian_u

FullMatrix< NumberType >	extractor_jacobian_du

FullMatrix< NumberType >	extractor_jacobian_ddu

std::vector< types::global_dof_index >	extractor_dof_indices

std::vector< double >	timings_variable_residual

std::vector< double >	timings_variable_jacobian

Static Protected Attributes
static constexpr int	nothing = 0

Detailed Description

template<typename Discretization_, typename Model_>
class DiFfRG::FEMAssembler< Discretization_, Model_ >

The basic assembler that can be used for any standard CG scheme with flux and source.

Template Parameters

Model The model class which contains the physical equations.

Member Typedef Documentation

◆ Components

template<typename Discretization_ , typename Model_ >

using DiFfRG::FEMAssembler< Discretization_, Model_ >::Components = typename Discretization::Components

◆ Discretization

template<typename Discretization_ , typename Model_ >

using DiFfRG::FEMAssembler< Discretization_, Model_ >::Discretization = Discretization_

◆ Model

template<typename Discretization_ , typename Model_ >

using DiFfRG::FEMAssembler< Discretization_, Model_ >::Model = Model_

◆ NumberType

template<typename Discretization_ , typename Model_ >

using DiFfRG::FEMAssembler< Discretization_, Model_ >::NumberType = typename Discretization::NumberType

◆ VectorType

template<typename Discretization_ , typename Model_ >

using DiFfRG::FEMAssembler< Discretization_, Model_ >::VectorType = typename Discretization::VectorType

Constructor & Destructor Documentation

◆ FEMAssembler()

template<typename Discretization_ , typename Model_ >

DiFfRG::FEMAssembler< Discretization_, Model_ >::FEMAssembler	(	Discretization &	discretization,
		Model &	model,
		const JSONValue &	json )

inline

Member Function Documentation

◆ attach_data_output()

template<typename Discretization_ , typename Model_ >

virtual void DiFfRG::FEMAssembler< Discretization_, Model_ >::attach_data_output	(	DataOutput< dim, VectorType > &	data_out,
		const VectorType &	solution,
		const VectorType &	variables,
		const VectorType &	dt_solution = VectorType(),
		const VectorType &	residual = VectorType() )

inlineoverridevirtual

◆ average_time_variable_jacobian_assembly()

template<typename Discretization_ , typename Model_ >

double DiFfRG::FEMAssembler< Discretization_, Model_ >::average_time_variable_jacobian_assembly ( )

inline

◆ average_time_variable_residual_assembly()

template<typename Discretization_ , typename Model_ >

double DiFfRG::FEMAssembler< Discretization_, Model_ >::average_time_variable_residual_assembly ( )

inline

◆ e_tie()

template<typename Discretization_ , typename Model_ >

template<typename... T>

static constexpr auto DiFfRG::FEMAssembler< Discretization_, Model_ >::e_tie ( T &&... t )

inlinestaticconstexprprotected

◆ extract()

template<typename Discretization_ , typename Model_ >

void DiFfRG::FEMAssembler< Discretization_, Model_ >::extract	(	std::array< NumberType, Components::count_extractors()> &	data,
		const VectorType &	solution_global,
		const VectorType &	variables,
		bool	search_EoM,
		bool	set_EoM,
		bool	postprocess ) const

inline

◆ get_differential_indices()

template<typename Discretization_ , typename Model_ >

virtual IndexSet DiFfRG::FEMAssembler< Discretization_, Model_ >::get_differential_indices ( ) const

inlineoverridevirtual

Obtain the dofs which contain time derivatives.

Returns: IndexSet The indices of the dofs which contain time derivatives

Implements DiFfRG::AbstractAssembler< Discretization_::VectorType, Discretization_::SparseMatrixType, Discretization_::dim >.

◆ get_discretization() [1/2]

template<typename Discretization_ , typename Model_ >

auto & DiFfRG::FEMAssembler< Discretization_, Model_ >::get_discretization ( )

inline

◆ get_discretization() [2/2]

template<typename Discretization_ , typename Model_ >

const auto & DiFfRG::FEMAssembler< Discretization_, Model_ >::get_discretization ( ) const

inline

◆ jacobian_extractors()

template<typename Discretization_ , typename Model_ >

bool DiFfRG::FEMAssembler< Discretization_, Model_ >::jacobian_extractors	(	FullMatrix< NumberType > &	extractor_jacobian,
		const VectorType &	solution_global,
		const VectorType &	variables )

inline

◆ jacobian_variables()

template<typename Discretization_ , typename Model_ >

virtual void DiFfRG::FEMAssembler< Discretization_, Model_ >::jacobian_variables	(	FullMatrix< NumberType > &	jacobian,
		const VectorType &	variables,
		const VectorType &	spatial_solution )

inlineoverridevirtual

◆ num_variable_jacobians()

template<typename Discretization_ , typename Model_ >

uint DiFfRG::FEMAssembler< Discretization_, Model_ >::num_variable_jacobians ( ) const

inline

◆ num_variable_residuals()

template<typename Discretization_ , typename Model_ >

uint DiFfRG::FEMAssembler< Discretization_, Model_ >::num_variable_residuals ( ) const

inline

◆ readouts()

template<typename Discretization_ , typename Model_ >

void DiFfRG::FEMAssembler< Discretization_, Model_ >::readouts	(	DataOutput< dim, VectorType > &	data_out,
		const VectorType &	solution_global,
		const VectorType &	variables ) const

inline

◆ rebuild_jacobian_sparsity()

template<typename Discretization_ , typename Model_ >

virtual void DiFfRG::FEMAssembler< Discretization_, Model_ >::rebuild_jacobian_sparsity ( )

pure virtual

Implemented in DiFfRG::CG::Assembler< Discretization_, Model_ >, DiFfRG::dDG::Assembler< Discretization_, Model_ >, and DiFfRG::DG::Assembler< Discretization_, Model_ >.

◆ refinement_indicator()

template<typename Discretization_ , typename Model_ >

virtual void DiFfRG::FEMAssembler< Discretization_, Model_ >::refinement_indicator	(	Vector< double > &	,
		const VectorType &	)

pure virtual

Implemented in DiFfRG::dDG::Assembler< Discretization_, Model_ >.

◆ reinit()

template<typename Discretization_ , typename Model_ >

virtual void DiFfRG::FEMAssembler< Discretization_, Model_ >::reinit ( )

inlineoverridevirtual

Reinitialize the assembler. This is necessary if the mesh has changed, e.g. after a mesh refinement.

Implements DiFfRG::AbstractAssembler< Discretization_::VectorType, Discretization_::SparseMatrixType, Discretization_::dim >.

Reimplemented in DiFfRG::CG::Assembler< Discretization_, Model_ >, DiFfRG::dDG::Assembler< Discretization_, Model_ >, and DiFfRG::DG::Assembler< Discretization_, Model_ >.

◆ residual_variables()

template<typename Discretization_ , typename Model_ >

virtual void DiFfRG::FEMAssembler< Discretization_, Model_ >::residual_variables	(	VectorType &	residual,
		const VectorType &	variables,
		const VectorType &	spatial_solution )

inlineoverridevirtual

◆ set_time()

template<typename Discretization_ , typename Model_ >

virtual void DiFfRG::FEMAssembler< Discretization_, Model_ >::set_time ( double t )

inlineoverridevirtual

Set the current time. The assembler should usually just forward this to the numerical model.

Parameters

t	The current time

Implements DiFfRG::AbstractAssembler< Discretization_::VectorType, Discretization_::SparseMatrixType, Discretization_::dim >.

◆ v_tie()

template<typename Discretization_ , typename Model_ >

template<typename... T>

static constexpr auto DiFfRG::FEMAssembler< Discretization_, Model_ >::v_tie ( T &&... t )

inlinestaticconstexprprotected

Member Data Documentation

◆ batch_size

template<typename Discretization_ , typename Model_ >

uint DiFfRG::FEMAssembler< Discretization_, Model_ >::batch_size

protected

◆ dim

template<typename Discretization_ , typename Model_ >

uint DiFfRG::FEMAssembler< Discretization_, Model_ >::dim = Discretization::dim

staticconstexpr

◆ discretization

template<typename Discretization_ , typename Model_ >

Discretization& DiFfRG::FEMAssembler< Discretization_, Model_ >::discretization

protected

◆ dof_handler

template<typename Discretization_ , typename Model_ >

const DoFHandler<dim>& DiFfRG::FEMAssembler< Discretization_, Model_ >::dof_handler

protected

◆ EoM

template<typename Discretization_ , typename Model_ >

Point<dim> DiFfRG::FEMAssembler< Discretization_, Model_ >::EoM

mutableprotected

◆ EoM_abs_tol

template<typename Discretization_ , typename Model_ >

const double DiFfRG::FEMAssembler< Discretization_, Model_ >::EoM_abs_tol

protected

◆ EoM_cell

template<typename Discretization_ , typename Model_ >

DoFHandler<dim>::cell_iterator DiFfRG::FEMAssembler< Discretization_, Model_ >::EoM_cell

mutableprotected

◆ EoM_max_iter

template<typename Discretization_ , typename Model_ >

const uint DiFfRG::FEMAssembler< Discretization_, Model_ >::EoM_max_iter

protected

◆ extractor_dof_indices

template<typename Discretization_ , typename Model_ >

std::vector<types::global_dof_index> DiFfRG::FEMAssembler< Discretization_, Model_ >::extractor_dof_indices

protected

◆ extractor_jacobian

template<typename Discretization_ , typename Model_ >

FullMatrix<NumberType> DiFfRG::FEMAssembler< Discretization_, Model_ >::extractor_jacobian

protected

◆ extractor_jacobian_ddu

template<typename Discretization_ , typename Model_ >

FullMatrix<NumberType> DiFfRG::FEMAssembler< Discretization_, Model_ >::extractor_jacobian_ddu

protected

◆ extractor_jacobian_du

template<typename Discretization_ , typename Model_ >

FullMatrix<NumberType> DiFfRG::FEMAssembler< Discretization_, Model_ >::extractor_jacobian_du

protected

◆ extractor_jacobian_u

template<typename Discretization_ , typename Model_ >

FullMatrix<NumberType> DiFfRG::FEMAssembler< Discretization_, Model_ >::extractor_jacobian_u

protected

◆ fe

template<typename Discretization_ , typename Model_ >

const FiniteElement<dim>& DiFfRG::FEMAssembler< Discretization_, Model_ >::fe

protected

◆ mapping

template<typename Discretization_ , typename Model_ >

const Mapping<dim>& DiFfRG::FEMAssembler< Discretization_, Model_ >::mapping

protected

◆ model

template<typename Discretization_ , typename Model_ >

Model& DiFfRG::FEMAssembler< Discretization_, Model_ >::model

protected

◆ nothing

template<typename Discretization_ , typename Model_ >

int DiFfRG::FEMAssembler< Discretization_, Model_ >::nothing = 0

staticconstexprprotected

◆ old_EoM_cell

template<typename Discretization_ , typename Model_ >

DoFHandler<dim>::cell_iterator DiFfRG::FEMAssembler< Discretization_, Model_ >::old_EoM_cell

protected

◆ threads

template<typename Discretization_ , typename Model_ >

uint DiFfRG::FEMAssembler< Discretization_, Model_ >::threads

protected

◆ timings_variable_jacobian

template<typename Discretization_ , typename Model_ >

std::vector<double> DiFfRG::FEMAssembler< Discretization_, Model_ >::timings_variable_jacobian

protected

◆ timings_variable_residual

template<typename Discretization_ , typename Model_ >

std::vector<double> DiFfRG::FEMAssembler< Discretization_, Model_ >::timings_variable_residual

protected

The documentation for this class was generated from the following file:

/home/runner/work/DiFfRG/DiFfRG/DiFfRG/include/DiFfRG/discretization/FEM/assembler/common.hh

Public Types

Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Components

◆ Discretization

◆ Model

◆ NumberType

◆ VectorType

Constructor & Destructor Documentation

◆ FEMAssembler()

Member Function Documentation

◆ attach_data_output()

◆ average_time_variable_jacobian_assembly()

◆ average_time_variable_residual_assembly()

◆ e_tie()

◆ extract()

◆ get_differential_indices()

◆ get_discretization() [1/2]

◆ get_discretization() [2/2]

◆ jacobian_extractors()

◆ jacobian_variables()

◆ num_variable_jacobians()

◆ num_variable_residuals()

◆ readouts()

◆ rebuild_jacobian_sparsity()

◆ refinement_indicator()

◆ reinit()

◆ residual_variables()

◆ set_time()

◆ v_tie()

Member Data Documentation

◆ batch_size

◆ dim

◆ discretization

◆ dof_handler

◆ EoM

◆ EoM_abs_tol

◆ EoM_cell

◆ EoM_max_iter

◆ extractor_dof_indices

◆ extractor_jacobian

◆ extractor_jacobian_ddu

◆ extractor_jacobian_du

◆ extractor_jacobian_u

◆ fe

◆ mapping

◆ model

◆ nothing

◆ old_EoM_cell

◆ threads

◆ timings_variable_jacobian

◆ timings_variable_residual