BuoyancyProvider.h

Go to the documentation of this file.

//=======================================================================================
// ____          ____    __    ______     __________   __      __       __        __
// \    \       |    |  |  |  |   _   \  |___    ___| |  |    |  |     /  \      |  |
//  \    \      |    |  |  |  |  |_)   |     |  |     |  |    |  |    /    \     |  |
//   \    \     |    |  |  |  |   _   /      |  |     |  |    |  |   /  /\  \    |  |
//    \    \    |    |  |  |  |  | \  \      |  |     |   \__/   |  /  ____  \   |  |____
//     \    \   |    |  |__|  |__|  \__\     |__|      \________/  /__/    \__\  |_______|
//      \    \  |    |   ________________________________________________________________
//       \    \ |    |  |  ______________________________________________________________|
//        \    \|    |  |  |         __          __     __     __     ______      _______
//         \         |  |  |_____   |  |        |  |   |  |   |  |   |   _  \    /  _____)
//          \        |  |   _____|  |  |        |  |   |  |   |  |   |  | \  \   \_______
//           \       |  |  |        |  |_____   |   \_/   |   |  |   |  |_/  /    _____  |
//            \ _____|  |__|        |________|   \_______/    |__|   |______/    (_______/
//
//  This file is part of VirtualFluids. VirtualFluids is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  VirtualFluids is distributed in the hope that it will be useful, but WITHOUT
//  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
//  for more details.
//
//  SPDX-License-Identifier: GPL-3.0-or-later
//  SPDX-FileCopyrightText: Copyright © VirtualFluids Project contributors, see AUTHORS.md in root folder
//
//=======================================================================================
 
#ifndef BUOYANCY_PROVIDER_H
#define BUOYANCY_PROVIDER_H
 
#include <utility>
#include <vector>
 
#include <basics/DataTypes.h>
#include <basics/PointerDefinitions.h>
 
#include <logger/Logger.h>
 
#include "gpu/core/Parameter/Parameter.h"
#include "gpu/core/PreCollisionInteractor/PreCollisionInteractor.h"
 
namespace vf::gpu {
 
class GridProvider;
class CudaMemoryManager;
 
class BuoyancyProviderConstantValue : public PreCollisionInteractor
{
 
public:
    BuoyancyProviderConstantValue(std::shared_ptr<Parameter> parameter, std::shared_ptr<CudaMemoryManager> cudaMemoryManager)
        : PreCollisionInteractor(std::move(parameter), std::move(cudaMemoryManager))
    {
        VF_LOG_INFO("Using BuoyancyProviderConstantValue");
 
        if (!para->getBuoyancyEnabled())
            throw std::runtime_error("BuoyancyProvider: buoyancy needs to be enabled in Parameter!");
    }
    ~BuoyancyProviderConstantValue() override = default;
 
    void init() override {};
    void interact(int level, uint ) override;
    void getTaggedFluidNodes(GridProvider* ) override {};
};
 
class BuoyancyProviderPlanarAverage : public PreCollisionInteractor
{
public:
    BuoyancyProviderPlanarAverage(std::shared_ptr<Parameter> parameter, std::shared_ptr<CudaMemoryManager> cudaMemoryManager)
        : PreCollisionInteractor(std::move(parameter), std::move(cudaMemoryManager))
    {
        VF_LOG_INFO("Using BuoyancyProviderPlanarAverage with buoyancy factor {}", para->getBuoyancyFactor());
        if (!para->getBuoyancyEnabled())
            throw std::runtime_error("BuoyancyProvider: buoyancy needs to be enabled in Parameter!");
    }
 
    ~BuoyancyProviderPlanarAverage() override;
 
    void init() override;
    void interact(int level, uint ) override;
    void getTaggedFluidNodes(GridProvider* ) override {};
 
    struct ProfileParameters
    {
        uint numberOfPlanes;
        real *referenceTemperaturesHost = nullptr, *referenceTemperaturesDevice = nullptr;
        uint *indicesHost = nullptr, *indicesDevice = nullptr;
        ProfileParameters(uint numberOfPlanes) : numberOfPlanes(numberOfPlanes)
        {
        }
    };
 
    struct ReductionParameters
    {
        uint numberOfPlanes;
        uint *numberOfNodesPerPlaneHost = nullptr, *numberOfNodesPerPlaneDevice = nullptr;
        size_t sizeOfTemporaryMemory = 0;
        void* temporaryMemory = nullptr;
        ReductionParameters(uint numberOfPlanes) : numberOfPlanes(numberOfPlanes)
        {
        }
    };
 
    ProfileParameters& getProfileParameter(int level)
    {
        return profileParameters[level];
    }
    ReductionParameters& getReductionParameter(int level)
    {
        return reductionParameters[level];
    }
 
private:
    uint numberOfInitialReferenceValues;
    int streamIndex;
    std::vector<ProfileParameters> profileParameters;
    std::vector<ReductionParameters> reductionParameters;
};
 
}
 
#endif