integration.hpp

Go to the documentation of this file.

/*------------------------------- phasicFlow ---------------------------------
      O        C enter of
     O O       E ngineering and
    O   O      M ultiscale modeling of
   OOOOOOO     F luid flow       
------------------------------------------------------------------------------
  Copyright (C): www.cemf.ir
  email: hamid.r.norouzi AT gmail.com
------------------------------------------------------------------------------  
Licence:
  This file is part of phasicFlow code. It is a free software for simulating 
  granular and multiphase flows. You can redistribute it and/or modify it under
  the terms of GNU General Public License v3 or any other later versions. 
 
  phasicFlow is distributed to help others in their research in the field of 
  granular and multiphase flows, but WITHOUT ANY WARRANTY; without even the
  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
-----------------------------------------------------------------------------*/
 
#ifndef __integration_hpp__
#define __integration_hpp__
 
 
#include "virtualConstructor.hpp"
#include "pointFields.hpp"
 
 
namespace pFlow
{
 
// - Forward
class repository;
class pointStructure;
 
class integration
{
private:
 
    // - Protected data members 
 
        repository& owner_;
 
        const pointStructure& pStruct_;
 
        const word baseName_;
 
public:
 
    TypeInfo("integration");
 
 
    // - Constructors
 
        integration(
            const word& baseName,
            pointStructure& pStruct,
            const word& method,
            const realx3Field_D& initialValField);
 
        integration(const integration&) = default;
 
        integration(integration&&) = default;
 
        integration& operator = (const integration&) = default;
 
        integration& operator = (integration&&) = default;
 
        virtual ~integration()=default;
 
        create_vCtor
        (
            integration,
            word,
            (
                const word& baseName,
                pointStructure& pStruct,
                const word& method,
                const realx3Field_D& initialValField
            ),
            (baseName, pStruct, method, initialValField)
        );
 
 
    // - Methods
 
        inline
        const auto& pStruct()const
        {
            return pStruct_;
        }
 
        inline
        const word& baseName()const
        {
            return baseName_;
        }
 
        inline
        repository& owner()
        {
            return owner_;
        }
 
        virtual 
        void updateBoundariesSlaveToMasterIfRequested() = 0;
        virtual 
        word method()const = 0 ;
 
        virtual 
        bool predict(real dt, realx3PointField_D& y, realx3PointField_D& dy) = 0;
 
        virtual 
        bool predict(real dt, realx3Field_D& y, realx3PointField_D& dy) = 0;
 
        virtual 
        bool correct(real dt, realx3PointField_D& y, realx3PointField_D& dy) = 0;
 
        virtual 
        bool correctPStruct(real dt, pointStructure& pStruct, realx3PointField_D& vel) = 0;
 
        virtual 
        bool setInitialVals(
                const int32IndexContainer& newIndices,
                const realx3Vector& y) = 0;
 
        virtual 
        bool needSetInitialVals()const = 0;
 
 
    static
        uniquePtr<integration> create(
            const word& baseName,
            pointStructure& pStruct,
            const word& method,
            const realx3Field_D& initialValField);
 
}; // integration
 
} // pFlow
 
 
#endif //__integration_hpp__