ExternalForces.hpp

Go to the documentation of this file.

// -------------------------------------------------------//
//
// SHAMROCK code for hydrodynamics
// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
//
// -------------------------------------------------------//
 
#pragma once
 
#include "shambackends/typeAliasVec.hpp"
#include "shambackends/vec.hpp"
#include "shammodels/sph/SolverConfig.hpp"
#include "shammodels/sph/modules/SolverStorage.hpp"
#include "shamrock/scheduler/ShamrockCtx.hpp"
 
namespace shammodels::sph::modules {
 
    template<class Tvec, template<class> class SPHKernel>
    class ExternalForces {
        public:
        using Tscal              = shambase::VecComponent<Tvec>;
        static constexpr u32 dim = shambase::VectorProperties<Tvec>::dimension;
        using Kernel             = SPHKernel<Tscal>;
 
        using Config  = SolverConfig<Tvec, SPHKernel>;
        using Storage = SolverStorage<Tvec, u32>;
 
        ShamrockCtx &context;
        Config &solver_config;
        Storage &storage;
 
        ExternalForces(ShamrockCtx &context, Config &solver_config, Storage &storage)
            : context(context), solver_config(solver_config), storage(storage) {}
 
        void compute_ext_forces_indep_v();
 
        void add_ext_forces();
 
        void point_mass_accrete_particles();
 
        private:
        using SolverConfigExtForce     = typename Config::ExtForceConfig;
        using EF_PointMass             = typename SolverConfigExtForce::PointMass;
        using EF_LenseThirring         = typename SolverConfigExtForce::LenseThirring;
        using EF_ShearingBoxForce      = typename SolverConfigExtForce::ShearingBoxForce;
        using EF_VerticalDiscPotential = typename SolverConfigExtForce::VerticalDiscPotential;
        using EF_VelocityDissipation   = typename SolverConfigExtForce::VelocityDissipation;
 
        inline PatchScheduler &scheduler() { return shambase::get_check_ref(context.sched); }
    };
 
} // namespace shammodels::sph::modules