ApplicationsLib::LinearSolverLibrarySetup Struct Reference

Detailed Description

The LinearSolverLibrarySetup takes care of proper initialization and shutting down of an external linear solver library. The concrete implementation is chosen by the build system. An object of this class must be created at the beginning of the scope where it is used. When the scope closes (or the object is destroyed explicitly) library shutting down functions are automatically called. The default implementation is empty providing polymorphic behaviour when using this class.

Definition at line 20 of file LinearSolverLibrarySetup.h.

#include <LinearSolverLibrarySetup.h>

Inheritance diagram for ApplicationsLib::LinearSolverLibrarySetup:

Static Public Member Functions
OGS_EXPORT_SYMBOL static std::shared_ptr< LinearSolverLibrarySetup >	create (int argc, char *argv[])

Protected Member Functions
	LinearSolverLibrarySetup ()=default
virtual	~LinearSolverLibrarySetup ()

Private Member Functions
	LinearSolverLibrarySetup (const LinearSolverLibrarySetup &)=delete
LinearSolverLibrarySetup &	operator= (const LinearSolverLibrarySetup &)=delete

Constructor & Destructor Documentation

LinearSolverLibrarySetup() [1/2]

ApplicationsLib::LinearSolverLibrarySetup::LinearSolverLibrarySetup ( )

protecteddefault

Referenced by LinearSolverLibrarySetup(), and operator=().

~LinearSolverLibrarySetup()

ApplicationsLib::LinearSolverLibrarySetup::~LinearSolverLibrarySetup ( )

protectedvirtual

Definition at line 95 of file LinearSolverLibrarySetup.cpp.

{
    DBUG("Tearing down linear solver library setup.");
}

References DBUG().

LinearSolverLibrarySetup() [2/2]

ApplicationsLib::LinearSolverLibrarySetup::LinearSolverLibrarySetup ( const LinearSolverLibrarySetup & )

privatedelete

References LinearSolverLibrarySetup().

Member Function Documentation

create()

std::shared_ptr< LinearSolverLibrarySetup > ApplicationsLib::LinearSolverLibrarySetup::create ( int argc, char * argv[] )

static

Definition at line 100 of file LinearSolverLibrarySetup.cpp.

{
    static std::weak_ptr<LinearSolverLibrarySetup> instance;
    static std::mutex mutex;
 
    // Lock to avoid multiple initializations.
    std::lock_guard lock{mutex};
 
    std::shared_ptr lsls = instance.lock();
 
    if (!lsls)
    {
        DBUG("Initializing linear solver library for the first time");
        lsls =
            std::make_shared<detail::LinearSolverLibrarySetupImpl>(argc, argv);
 
        // Necessary such that the internally cached ptr and the returned ptr
        // both point to the same object, which might be returned from
        // subsequent create() calls.
        instance = lsls;
    }
    else
    {
        DBUG("Initializing linear solver library for the {}th time",
             lsls.use_count());
#if defined(USE_PETSC) || defined(USE_LIS)
        // PETSc and Lis parse commandline arguments. Therefore, we exclude them
        // for the time being such that nobody can accidentally pass
        // different arguments to different linear solver library setups.
        OGS_FATAL(
            "Reusing a LinearSolverLibrarySetup has not been defined for "
            "PETSc or LIS. In the present build configuration you cannot run "
            "two separate OGS simulations in the same process.");
#else
        // No initialization needed for Eigen, just return the internally cached
        // ptr.
#endif
    }
 
    // Consistency check that the internally cached ptr and the returned ptr
    // both point to the same object.
    // C++26 will have owner_equal()
    assert(!instance.owner_before(lsls) && !lsls.owner_before(instance));
 
    return lsls;
}

References DBUG(), and OGS_FATAL.

operator=()

LinearSolverLibrarySetup & ApplicationsLib::LinearSolverLibrarySetup::operator= ( const LinearSolverLibrarySetup & )

privatedelete

References LinearSolverLibrarySetup().

---

The documentation for this struct was generated from the following files:

• LinearSolverLibrarySetup.h
• LinearSolverLibrarySetup.cpp