base_body.h

Go to the documentation of this file.

/* -----------------------------------------------------------------------------*
 *                               SPHinXsys                                      *
 * -----------------------------------------------------------------------------*
 * SPHinXsys (pronunciation: s'finksis) is an acronym from Smoothed Particle    *
 * Hydrodynamics for industrial compleX systems. It provides C++ APIs for       *
 * physical accurate simulation and aims to model coupled industrial dynamic    *
 * systems including fluid, solid, multi-body dynamics and beyond with SPH      *
 * (smoothed particle hydrodynamics), a meshless computational method using     *
 * particle discretization.                                                     *
 *                                                                              *
 * SPHinXsys is partially funded by German Research Foundation                  *
 * (Deutsche Forschungsgemeinschaft) DFG HU1527/6-1, HU1527/10-1,               *
 * HU1527/12-1 and HU1527/12-4.                                                 *
 *                                                                              *
 * Portions copyright (c) 2017-2022 Technical University of Munich and          *
 * the authors' affiliations.                                                   *
 *                                                                              *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may      *
 * not use this file except in compliance with the License. You may obtain a    *
 * copy of the License at http://www.apache.org/licenses/LICENSE-2.0.           *
 *                                                                              *
 * -----------------------------------------------------------------------------*/
#ifndef BASE_BODY_H
#define BASE_BODY_H

#include "base_data_package.h"
#include "sph_data_containers.h"
#include "adaptation.h"
#include "cell_linked_list.h"
#include "particle_sorting.h"
#include "all_geometries.h"

#include <string>

namespace SPH
{
    class SPHSystem;
    class SPHBodyRelation;
    class BodySurface;

    class SPHBody
    {
    private:
        SharedPtrKeeper<Shape> shape_ptr_keeper_;

    public:
        Shape *body_shape_; 
    protected:
        UniquePtrKeeper<SPHAdaptation> sph_adaptation_ptr_keeper_;

    private:
        UniquePtrKeeper<BaseMaterial> base_material_ptr_keeper_;
        UniquePtrKeeper<BaseParticles> base_particles_ptr_keeper_;

    protected:
        SPHSystem &sph_system_;
        std::string body_name_;
        bool newly_updated_; 
        BoundingBox body_domain_bounds_;
        bool is_domain_bounds_determined_;

    public:
        SPHAdaptation *sph_adaptation_; 
        BaseMaterial *base_material_;   
        BaseParticles *base_particles_; 
        StdVec<SPHBodyRelation *> body_relations_; 
        explicit SPHBody(SPHSystem &sph_system, SharedPtr<Shape> shape_ptr);
        virtual ~SPHBody(){};

        std::string getBodyName();
        SPHSystem &getSPHSystem();
        Real getSPHBodyResolutionRef() { return sph_adaptation_->ReferenceSpacing(); };
        void setNewlyUpdated() { newly_updated_ = true; };
        void setNotNewlyUpdated() { newly_updated_ = false; };
        bool checkNewlyUpdated() { return newly_updated_; };
        void setBodyDomainBounds(const BoundingBox &body_domain_bounds);
        BoundingBox getBodyDomainBounds();
        BoundingBox getSPHSystemBounds();
        //----------------------------------------------------------------------
        //      Object factory template functions
        //----------------------------------------------------------------------
        template <typename... ConstructorArgs>
        LevelSetShape *defineComponentLevelSetShape(const std::string &shape_name, ConstructorArgs &&...args)
        {
            ComplexShape *complex_shape = DynamicCast<ComplexShape>(this, body_shape_);
            return complex_shape->defineLevelSetShape(this, shape_name, std::forward<ConstructorArgs>(args)...);
        };

        template <typename... ConstructorArgs>
        LevelSetShape *defineBodyLevelSetShape(ConstructorArgs &&...args)
        {
            LevelSetShape *levelset_shape =
                shape_ptr_keeper_.resetPtr<LevelSetShape>(this, *body_shape_, std::forward<ConstructorArgs>(args)...);
            body_shape_ = levelset_shape;
            return levelset_shape;
        };

        template <class ParticleType = BaseParticles, class MaterialType = BaseMaterial>
        void defineParticlesWithMaterial(MaterialType *material)
        {
            base_material_ = material;
            base_particles_ = base_particles_ptr_keeper_.createPtr<ParticleType>(*this, material);
        };

        template <class ParticleType = BaseParticles, class MaterialType = BaseMaterial, typename... ConstructorArgs>
        void defineParticlesAndMaterial(ConstructorArgs &&...args)
        {
            MaterialType *material = base_material_ptr_keeper_.createPtr<MaterialType>(std::forward<ConstructorArgs>(args)...);
            defineParticlesWithMaterial<ParticleType>(material);
        };

        template <class ParticleGeneratorType, typename... ConstructorArgs>
        void generateParticles(ConstructorArgs &&...args)
        {
            ParticleGeneratorType particle_generator(*this, std::forward<ConstructorArgs>(args)...);
            particle_generator.initializeGeometricVariables();
            base_particles_->initializeOtherVariables();
            base_material_->assignBaseParticles(base_particles_);
        };

        virtual void assignBaseParticles(BaseParticles *base_particles);
        void allocateConfigurationMemoriesForBufferParticles();

        template <typename VariableType>
        void addBodyStateForRecording(const std::string &variable_name)
        {
            base_particles_->template addVariableToWrite<VariableType>(variable_name);
        };

        template <class DerivedVariableMethod>
        void addDerivedBodyStateForRecording()
        {
            base_particles_->template addDerivedVariableToWrite<DerivedVariableMethod>();
        };

        virtual void writeParticlesToVtuFile(std::ostream &output_file);
        virtual void writeParticlesToVtpFile(std::ofstream &output_file);
        virtual void writeParticlesToPltFile(std::ofstream &output_file);
        virtual void writeSurfaceParticlesToVtuFile(std::ofstream &output_file, BodySurface &surface_particles);
        virtual void writeParticlesToXmlForRestart(std::string &filefullpath);
        virtual void readParticlesFromXmlForRestart(std::string &filefullpath);
        virtual void writeToXmlForReloadParticle(std::string &filefullpath);
        virtual void readFromXmlForReloadParticle(std::string &filefullpath);
        virtual SPHBody *ThisObjectPtr() { return this; };
    };

    class RealBody : public SPHBody
    {
    private:
        UniquePtrKeeper<BaseCellLinkedList> cell_linked_list_keeper_;
        BoundingBox system_domain_bounds_;
        SplitCellLists split_cell_lists_;
        bool use_split_cell_lists_;

    public:
        ParticleSorting particle_sorting_;
        BaseCellLinkedList *cell_linked_list_; 
        explicit RealBody(SPHSystem &sph_system, SharedPtr<Shape> shape_ptr);
        virtual ~RealBody(){};

        void setUseSplitCellLists() { use_split_cell_lists_ = true; };
        bool getUseSplitCellLists() { return use_split_cell_lists_; };
        SplitCellLists &getSplitCellLists() { return split_cell_lists_; };
        virtual void assignBaseParticles(BaseParticles *base_particles) override;
        virtual void sortParticleWithCellLinkedList();
        virtual void updateCellLinkedList();
        //----------------------------------------------------------------------
        //      Object factory template functions
        //----------------------------------------------------------------------
        template <class AdaptationType, typename... ConstructorArgs>
        void defineAdaptation(ConstructorArgs &&...args)
        {
            sph_adaptation_ = sph_adaptation_ptr_keeper_
                                  .createPtr<AdaptationType>(this, std::forward<ConstructorArgs>(args)...);
            cell_linked_list_ = cell_linked_list_keeper_.movePtr(
                sph_adaptation_->createCellLinkedList(system_domain_bounds_, *this));
        };
    };
}
#endif //BASE_BODY_H