ProcessLib::AssemblyMixin< Process > Class Template Reference

Detailed Description

template<typename Process>
class ProcessLib::AssemblyMixin< Process >

A mixin providing assembly functionality to a specific Process.

The process must be derived from this class (CRTP).

Definition at line 95 of file AssemblyMixin.h.

#include <AssemblyMixin.h>

Inheritance diagram for ProcessLib::AssemblyMixin< Process >:

Collaboration diagram for ProcessLib::AssemblyMixin< Process >:

Public Member Functions
void	initializeAssemblyOnSubmeshes (const int process_id, std::vector< std::reference_wrapper< MeshLib::Mesh > > const &submeshes, std::vector< std::string > const &residuum_names)
void	updateActiveElements (const int process_id)
void	assemble (const double, double const, std::vector< GlobalVector * > const &, std::vector< GlobalVector * > const &, int const, GlobalMatrix &, GlobalMatrix &, GlobalVector &)
void	assembleWithJacobian (const double t, double const dt, std::vector< GlobalVector * > const &x, std::vector< GlobalVector * > const &x_prev, int const process_id, GlobalMatrix &M, GlobalMatrix &K, GlobalVector &b, GlobalMatrix &Jac)

Private Member Functions
Process &	derived ()
Process const &	derived () const
template<typename Method , typename... Jac>
void	assembleGeneric (Method global_assembler_method, const double t, double const dt, std::vector< GlobalVector * > const &x, std::vector< GlobalVector * > const &x_prev, int const process_id, GlobalMatrix &M, GlobalMatrix &K, GlobalVector &b, Jac &... jac_or_not_jac)
	AssemblyMixinBase (AbstractJacobianAssembler &jacobian_assembler)
Private Member Functions inherited from ProcessLib::AssemblyMixinBase
	AssemblyMixinBase (AbstractJacobianAssembler &jacobian_assembler)
void	initializeAssemblyOnSubmeshes (const int process_id, MeshLib::Mesh &bulk_mesh, std::vector< std::reference_wrapper< MeshLib::Mesh > > const &submeshes, std::vector< std::string > const &residuum_names, std::vector< std::reference_wrapper< ProcessVariable > > const &pvs)
void	updateActiveElements (ProcessLib::ProcessVariable const &pv)

Private Attributes
friend	Process
Private Attributes inherited from ProcessLib::AssemblyMixinBase
std::vector< SubmeshAssemblyData >	submesh_assembly_data_
std::vector< std::reference_wrapper< MeshLib::PropertyVector< double > > >	residuum_vectors_bulk_
std::size_t	b_submesh_id_ = 0
	ID of the b vector on submeshes, cf. NumLib::VectorProvider.
Assembly::ParallelVectorMatrixAssembler	pvma_

Additional Inherited Members
Static Private Member Functions inherited from ProcessLib::AssemblyMixinBase
static void	copyResiduumVectorsToBulkMesh (GlobalVector const &rhs, NumLib::LocalToGlobalIndexMap const &local_to_global_index_map, std::vector< std::reference_wrapper< MeshLib::PropertyVector< double > > > residuum_vectors)
static void	copyResiduumVectorsToSubmesh (GlobalVector const &rhs, NumLib::LocalToGlobalIndexMap const &local_to_global_index_map, SubmeshAssemblyData const &sad)

Member Function Documentation

assemble()

template<typename Process >

void ProcessLib::AssemblyMixin< Process >::assemble ( const double , double const , std::vector< GlobalVector * > const & , std::vector< GlobalVector * > const & , int const , GlobalMatrix & , GlobalMatrix & , GlobalVector &  )

inline

Definition at line 145 of file AssemblyMixin.h.

    {
        /*
        DBUG("AssemblyMixin assemble(t={}, dt={}, process_id={}).", t, dt,
             process_id);
 
        assembleGeneric(&Assembly::ParallelVectorMatrixAssembler::assemble, t,
        dt, x, x_prev, process_id, M, K, b);
        */
        OGS_FATAL("Not yet implemented.");
    }

References OGS_FATAL.

assembleGeneric()

template<typename Process >

template<typename Method , typename... Jac>

void ProcessLib::AssemblyMixin< Process >::assembleGeneric ( Method global_assembler_method, const double t, double const dt, std::vector< GlobalVector * > const & x, std::vector< GlobalVector * > const & x_prev, int const process_id, GlobalMatrix & M, GlobalMatrix & K, GlobalVector & b, Jac &... jac_or_not_jac )

inlineprivate

Generic assembly routine covering both the case with and without Jacobian assembly.

Definition at line 186 of file AssemblyMixin.h.

    {
        // TODO why not getDOFTables(x.size()); ?
        std::vector<NumLib::LocalToGlobalIndexMap const*> const dof_tables{
            derived()._local_to_global_index_map.get()};
 
        auto const& loc_asms = derived().local_assemblers_;
 
        if (!submesh_assembly_data_.empty())
        {
            auto& b_submesh = NumLib::GlobalVectorProvider::provider.getVector(
                b, b_submesh_id_);
 
            for (auto const& sad : submesh_assembly_data_)
            {
                b_submesh.setZero();
 
                (pvma_.*global_assembler_method)(
                    loc_asms, sad.active_element_ids, dof_tables, t, dt, x,
                    x_prev, process_id, M, K, b_submesh, jac_or_not_jac...);
 
                MathLib::LinAlg::axpy(b, 1.0, b_submesh);
 
                AssemblyMixinBase::copyResiduumVectorsToSubmesh(
                    b_submesh, *(dof_tables.front()), sad);
            }
 
            NumLib::GlobalVectorProvider::provider.releaseVector(b_submesh);
        }
        else
        {
            // convention: process variable 0 governs where assembly takes
            // place (active element IDs)
            ProcessLib::ProcessVariable const& pv =
                derived().getProcessVariables(process_id)[0];
 
            (pvma_.*global_assembler_method)(
                loc_asms, pv.getActiveElementIDs(), dof_tables, t, dt, x,
                x_prev, process_id, M, K, b, jac_or_not_jac...);
        }
 
        AssemblyMixinBase::copyResiduumVectorsToBulkMesh(
            b, *(dof_tables.front()), residuum_vectors_bulk_);
    }

References ProcessLib::Process::_local_to_global_index_map, MathLib::LinAlg::axpy(), ProcessLib::AssemblyMixinBase::b_submesh_id_, ProcessLib::AssemblyMixinBase::copyResiduumVectorsToBulkMesh(), ProcessLib::AssemblyMixinBase::copyResiduumVectorsToSubmesh(), ProcessLib::AssemblyMixin< Process >::derived(), ProcessLib::ProcessVariable::getActiveElementIDs(), ProcessLib::Process::getProcessVariables(), NumLib::VectorProvider::getVector(), NumLib::GlobalVectorProvider::provider, ProcessLib::AssemblyMixinBase::pvma_, NumLib::VectorProvider::releaseVector(), ProcessLib::AssemblyMixinBase::residuum_vectors_bulk_, MathLib::EigenVector::setZero(), and ProcessLib::AssemblyMixinBase::submesh_assembly_data_.

Referenced by ProcessLib::AssemblyMixin< Process >::assembleWithJacobian().

assembleWithJacobian()

template<typename Process >

void ProcessLib::AssemblyMixin< Process >::assembleWithJacobian ( const double t, double const dt, std::vector< GlobalVector * > const & x, std::vector< GlobalVector * > const & x_prev, int const process_id, GlobalMatrix & M, GlobalMatrix & K, GlobalVector & b, GlobalMatrix & Jac )

inline

Definition at line 161 of file AssemblyMixin.h.

    {
        DBUG("AssemblyMixin assembleWithJacobian(t={}, dt={}, process_id={}).",
             t, dt, process_id);
 
        assembleGeneric(
            &Assembly::ParallelVectorMatrixAssembler::assembleWithJacobian, t,
            dt, x, x_prev, process_id, M, K, b, Jac);
    }

References ProcessLib::AssemblyMixin< Process >::assembleGeneric(), ProcessLib::Assembly::ParallelVectorMatrixAssembler::assembleWithJacobian(), and DBUG().

AssemblyMixinBase()

template<typename Process >

ProcessLib::AssemblyMixinBase::AssemblyMixinBase ( AbstractJacobianAssembler & jacobian_assembler )

inlineexplicitprivate

Definition at line 49 of file AssemblyMixin.h.

        : pvma_{jacobian_assembler} {};

derived() [1/2]

template<typename Process >

Process & ProcessLib::AssemblyMixin< Process >::derived ( )

inlineprivate

Definition at line 177 of file AssemblyMixin.h.

{ return static_cast<Process&>(*this); }

Referenced by ProcessLib::AssemblyMixin< Process >::assembleGeneric(), ProcessLib::AssemblyMixin< Process >::initializeAssemblyOnSubmeshes(), and ProcessLib::AssemblyMixin< Process >::updateActiveElements().

derived() [2/2]

template<typename Process >

Process const & ProcessLib::AssemblyMixin< Process >::derived ( ) const

inlineprivate

Definition at line 178 of file AssemblyMixin.h.

    {
        return static_cast<Process const&>(*this);
    }

initializeAssemblyOnSubmeshes()

template<typename Process >

void ProcessLib::AssemblyMixin< Process >::initializeAssemblyOnSubmeshes ( const int process_id, std::vector< std::reference_wrapper< MeshLib::Mesh > > const & submeshes, std::vector< std::string > const & residuum_names )

inline

Specifies that the assembly of the process should take place on the passed submeshes.

Note

This method must be called at most once.

Attention

The passed submeshes must be non-overlapping and must cover the entire simulation domain. The caller is responsible to meet this requirement.

The order of the passed residuum_names matters and must match the order of the residuum vectors in the process. Otherwise residuum output on submeshes will be wrong.

Note

As of January 2023 assembly on submeshes has neither been tested with domain decomposition, nor with domain deactivation nor staggered coupling. Use at your own risk in these cases.

Todo

Implement and test with domain decomposition, domain deactivation and staggered coupling.

Definition at line 124 of file AssemblyMixin.h.

    {
        AssemblyMixinBase::initializeAssemblyOnSubmeshes(
            process_id, derived().getMesh(), submeshes, residuum_names,
            derived().getProcessVariables(process_id));
    }

References ProcessLib::AssemblyMixin< Process >::derived(), getMesh(), and ProcessLib::AssemblyMixinBase::initializeAssemblyOnSubmeshes().

updateActiveElements()

template<typename Process >

void ProcessLib::AssemblyMixin< Process >::updateActiveElements ( const int process_id )

inline

Definition at line 134 of file AssemblyMixin.h.

    {
        // convention: process variable 0 governs where assembly takes place
        // (active element IDs)
        ProcessLib::ProcessVariable const& pv =
            derived().getProcessVariables(process_id)[0];
 
        AssemblyMixinBase::updateActiveElements(pv);
    }

References ProcessLib::AssemblyMixin< Process >::derived(), ProcessLib::Process::getProcessVariables(), and ProcessLib::AssemblyMixinBase::updateActiveElements().

Member Data Documentation

Process

template<typename Process >

friend ProcessLib::AssemblyMixin< Process >::Process

private

Definition at line 100 of file AssemblyMixin.h.

---

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

• ProcessLib/AssemblyMixin.h