OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

add some documentation

Browse Source
This commit is contained in:
Tobias Meyer Andersen 2024-04-15 15:41:58 +02:00
parent e275c637f5
commit d97d7ba732
1 changed files with 24 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
opm/simulators/linalg/PreconditionerWithUpdate.hpp
View File

@ -77,15 +77,27 @@ private:
OriginalPreconditioner orig_precond_; OriginalPreconditioner orig_precond_;
}; };
template <class OriginalPreconditioner, class... Args>
std::shared_ptr<DummyUpdatePreconditioner<OriginalPreconditioner>>
getDummyUpdateWrapper(Args&&... args)
{
return std::make_shared<DummyUpdatePreconditioner<OriginalPreconditioner>>(std::forward<Args>(args)...);
}
/// @brief Interface class ensuring make function is overriden
/// @tparam OriginalPreconditioner - An arbitrary Preconditioner type
template <class OriginalPreconditioner> template <class OriginalPreconditioner>
struct AbstractPreconditionerWithUpdateMaker struct GeneralPreconditionerMaker
{ {
virtual std::unique_ptr<Preconditioner<typename OriginalPreconditioner::domain_type, typename OriginalPreconditioner::range_type>> make() = 0; virtual std::unique_ptr<Preconditioner<typename OriginalPreconditioner::domain_type, typename OriginalPreconditioner::range_type>> make() = 0;
// virtual ~AbstractMaker() {};
}; };
/// @brief Struct implementing a make function which creates a preconditioner
/// Can create arbitrary preconditioners using parameter packs as template arguments
/// @tparam OriginalPreconditioner - An arbitrary preconditioner type
/// @tparam ...Args - All arguments needed to construct the preconditioner of choice
template <class OriginalPreconditioner, class... Args> template <class OriginalPreconditioner, class... Args>
struct PreconditionerMaker : public AbstractPreconditionerWithUpdateMaker<OriginalPreconditioner> struct PreconditionerMaker : public GeneralPreconditionerMaker<OriginalPreconditioner>
{ {
PreconditionerMaker(Args&&... args) PreconditionerMaker(Args&&... args)
: args_(args...) : args_(args...)
@ -98,34 +110,9 @@ struct PreconditionerMaker : public AbstractPreconditionerWithUpdateMaker<Origin
std::tuple<Args...> args_; std::tuple<Args...> args_;
}; };
// struct Contain /// @brief Wrapper class of preconditioners that should be reconstructed on update
// { /// @tparam OriginalPreconditioner - Preconditioner of your choice
// Contain() /// @tparam ...Args - All arguments neededc to construct the preconditioner of choice
// {
// }
// template <class Product, class... Args>
// void fill(Args&&... args)
// {
// using MakerType = Maker<Product, Args...>;
// maker = std::make_unique<MakerType>(std::forward<Args>(args)...);
// recreate();
// }
// void recreate()
// {
// product = maker->make();
// }
// std::unique_ptr<AbstractMaker> maker;
// std::unique_ptr<AbstractProduct> product;
// };
template <class OriginalPreconditioner, class... Args>
std::shared_ptr<DummyUpdatePreconditioner<OriginalPreconditioner>>
getDummyUpdateWrapper(Args&&... args)
{
return std::make_shared<DummyUpdatePreconditioner<OriginalPreconditioner>>(std::forward<Args>(args)...);
}
template <class OriginalPreconditioner, class... Args> template <class OriginalPreconditioner, class... Args>
class RebuildOnUpdatePreconditioner : public PreconditionerWithUpdate<typename OriginalPreconditioner::domain_type, class RebuildOnUpdatePreconditioner : public PreconditionerWithUpdate<typename OriginalPreconditioner::domain_type,
typename OriginalPreconditioner::range_type> typename OriginalPreconditioner::range_type>
@ -164,21 +151,23 @@ public:
// Rebuild the preconditioner on update // Rebuild the preconditioner on update
void update() override void update() override
{ {
// orig_precond_ = std::make_unique<OriginalPreconditioner>(mat_, n_, w_, resort_);
orig_precond_ = preconditioner_maker_->make(); orig_precond_ = preconditioner_maker_->make();
} }
private: private:
using AbstractMakerType = AbstractPreconditionerWithUpdateMaker<OriginalPreconditioner>; using AbstractMakerType = GeneralPreconditionerMaker<OriginalPreconditioner>;
using ConcreteMakerType = PreconditionerMaker<OriginalPreconditioner, Args...>; using ConcreteMakerType = PreconditionerMaker<OriginalPreconditioner, Args...>;
std::tuple<Args...> preconditioner_params_; std::tuple<Args...> preconditioner_params_;
std::unique_ptr<AbstractMakerType> preconditioner_maker_; std::unique_ptr<AbstractMakerType> preconditioner_maker_;
// std::unique_ptr<ConcreteMakerType> preconditioner_maker_;
// std::unique_ptr<OriginalPreconditioner> orig_precond_;
std::unique_ptr<Preconditioner<typename OriginalPreconditioner::domain_type,typename OriginalPreconditioner::range_type>> orig_precond_; std::unique_ptr<Preconditioner<typename OriginalPreconditioner::domain_type,typename OriginalPreconditioner::range_type>> orig_precond_;
}; };
/// @brief Wrapper function creating and return a shared pointer to a preconditioner which is reconstructed on update
/// @tparam OriginalPreconditioner - Preconditioner of your choice
/// @tparam ...Args - Types of the arguments needed in the preconditioner constructed
/// @param ...args - Arguments needed to construct the preconditioner of choice
/// @return Shared pointer to preconditioner which has an update function that reconstrcuts the preconditioner
template <class OriginalPreconditioner, class... Args> template <class OriginalPreconditioner, class... Args>
std::shared_ptr<RebuildOnUpdatePreconditioner<OriginalPreconditioner, Args...>> std::shared_ptr<RebuildOnUpdatePreconditioner<OriginalPreconditioner, Args...>>
getRebuildOnUpdateWrapper(Args... args) getRebuildOnUpdateWrapper(Args... args)
@ -186,13 +175,6 @@ getRebuildOnUpdateWrapper(Args... args)
return std::make_shared<RebuildOnUpdatePreconditioner<OriginalPreconditioner, Args...>>(std::forward<Args>(args)...); return std::make_shared<RebuildOnUpdatePreconditioner<OriginalPreconditioner, Args...>>(std::forward<Args>(args)...);
} }
// template <class OriginalPreconditioner, class Matrix>
// std::shared_ptr<RebuildOnUpdatePreconditioner<OriginalPreconditioner, Matrix>>
// getRebuildOnUpdateWrapper(const Matrix &mat, const int n, const double w, const bool resort)
// {
// return std::make_shared<RebuildOnUpdatePreconditioner<OriginalPreconditioner, Matrix>>(mat, n, w, resort);
// }
} // namespace Dune } // namespace Dune
#endif // OPM_PRECONDITIONERWITHUPDATE_HEADER_INCLUDED #endif // OPM_PRECONDITIONERWITHUPDATE_HEADER_INCLUDED