The main structure is tested. functons like execute and write are added and tested.

other components are left

src/PostprocessData/operation/includeMask/IncludeMask.hpp

@@ -0,0 +1,192 @@
+/*------------------------------- 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 __IncludeMask_hpp__
+#define __IncludeMask_hpp__
+
+#include "dictionary.hpp"
+#include "includeMask.hpp"
+#include "fieldsDataBase.hpp"
+#include "maskOperations.hpp"
+#include "Time.hpp"
+
+
+namespace pFlow
+{
+
+
+template<typename T, typename Operator>
+class IncludeMask
+:
+	public includeMask
+{
+public:
+
+    using Mask = typename includeMask::Mask;
+
+private:
+	
+    std::vector<bool>       mask_;
+
+    Operator                operator_;
+
+    word                    fieldName_;
+    
+    timeValue               lastUpdated_ = -1;
+
+    bool updateMask()
+    {
+        timeValue t = database().currentTime();
+        
+        if( equal( t, lastUpdated_)) return true;
+        
+        span<T> s;
+        if constexpr (std::is_same_v<T,real>)
+        {
+            s = database().updateFieldReal(fieldName_);
+        }
+        else if constexpr ( std::is_same_v<T,realx3>)
+        {
+            s = database().updateFieldRealx3(fieldName_);
+        }
+        else if constexpr( std::is_same_v<T,realx4>)
+        {
+            s = database().updateFieldRealx4(fieldName_);   
+        }
+        else
+        {
+            fatalErrorInFunction<<"Type "<< getTypeName<T>()
+                <<" is not supported for  IncludeMask for field "
+                << fieldName_ << endl;
+            return false;
+        }
+        
+        
+        mask_.resize(s.size());
+
+        for(uint32 i=0; i<s.size(); i++)
+        {
+            mask_[i] = operator_(s[i]);
+        }
+
+        lastUpdated_ = t ;
+        
+        return true;
+    }
+
+    static
+    word operatorName()
+    {
+        return Operator::TYPENAME();
+    }
+
+public:
+
+	TypeInfoTemplate12("IncludeMask", T, Operator);
+
+	IncludeMask(
+		const dictionary& dict, 
+        fieldsDataBase& feildsDB)
+	:
+		includeMask(dict, feildsDB),
+		operator_(dict.subDict(operatorName()+"Info")),
+        fieldName_(
+            dict.subDict
+            (
+                operatorName()+"Info"
+            ).getVal<word>("field"))
+	{}
+
+	add_vCtor(
+		includeMask,
+		IncludeMask,
+		dictionary);
+
+    Mask getMask() override
+    {
+        updateMask();
+        return Mask(mask_);
+    }
+	
+};
+
+
+template<typename T>
+class IncludeMask<T,allOp<T>>
+:
+	public includeMask
+{
+public:
+
+    using Mask = typename includeMask::Mask;
+
+private:
+	
+    std::vector<bool>       mask_;
+
+    timeValue               lastUpdated_ = -1;
+
+    bool updateMask()
+    {
+        timeValue t = database().currentTime();
+        
+        if( equal( t, lastUpdated_)) return true;
+        
+        span<realx3>  s = database().updatePoints();        
+        mask_.resize(s.size(), true);
+
+        lastUpdated_ = t ;
+        
+        return true;
+    }   
+
+public:
+
+	TypeInfoTemplate12("IncludeMask", T, allOp<int8>);
+
+	IncludeMask(
+		const dictionary& opDict, 
+        fieldsDataBase& feildsDB)
+	:
+		includeMask(opDict, feildsDB)
+	{
+        span<realx3>  s = database().updatePoints();        
+        mask_.resize(s.size(), true);
+	}
+
+	add_vCtor(
+		includeMask,
+		IncludeMask,
+		dictionary);
+
+    Mask getMask()override
+    {
+        updateMask();
+        return Mask(mask_);
+    }
+	
+};
+
+
+} // pFlow
+
+#endif //__IncludeMask_hpp__
+
+

src/PostprocessData/operation/includeMask/IncludeMasks.cpp

@@ -0,0 +1,50 @@
+/*------------------------------- 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.
+
+-----------------------------------------------------------------------------*/
+
+#include "IncludeMask.hpp"
+
+// real
+template class pFlow::IncludeMask<pFlow::real, pFlow::compareOne<pFlow::real, pFlow::lessThanOp> >;
+template class pFlow::IncludeMask<pFlow::real, pFlow::compareOne<pFlow::real, pFlow::lessThanEqOp> >;
+
+template class pFlow::IncludeMask<pFlow::real, pFlow::compareOne<pFlow::real, pFlow::greaterThanOp> >;
+template class pFlow::IncludeMask<pFlow::real, pFlow::compareOne<pFlow::real, pFlow::greaterThanEqOp> >;
+
+template class pFlow::IncludeMask<pFlow::real, pFlow::compareOne<pFlow::real, pFlow::equalOp> >;
+
+template class pFlow::IncludeMask<pFlow::real, pFlow::compareTwo<pFlow::real, pFlow::betweenOp> >;
+template class pFlow::IncludeMask<pFlow::real, pFlow::compareTwo<pFlow::real, pFlow::betweenEqOp> >;
+
+template class pFlow::IncludeMask<pFlow::real, pFlow::allOp<pFlow::real>>;
+
+// realx3
+template class pFlow::IncludeMask<pFlow::realx3, pFlow::compareOne<pFlow::realx3, pFlow::lessThanOp> >;
+template class pFlow::IncludeMask<pFlow::realx3, pFlow::compareOne<pFlow::realx3, pFlow::lessThanEqOp> >;
+
+template class pFlow::IncludeMask<pFlow::realx3, pFlow::compareOne<pFlow::realx3, pFlow::greaterThanOp> >;
+template class pFlow::IncludeMask<pFlow::realx3, pFlow::compareOne<pFlow::realx3, pFlow::greaterThanEqOp> >;
+
+template class pFlow::IncludeMask<pFlow::realx3, pFlow::compareOne<pFlow::realx3, pFlow::equalOp> >;
+
+template class pFlow::IncludeMask<pFlow::realx3, pFlow::compareTwo<pFlow::realx3, pFlow::betweenOp> >;
+template class pFlow::IncludeMask<pFlow::realx3, pFlow::compareTwo<pFlow::realx3, pFlow::betweenEqOp> >;
+
+
+// realx4

src/PostprocessData/operation/includeMask/includeMask.cpp

@@ -0,0 +1,91 @@
+/*------------------------------- 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.
+
+-----------------------------------------------------------------------------*/
+
+
+#include "includeMask.hpp"
+#include "dictionary.hpp"
+#include "fieldsDataBase.hpp"
+
+
+pFlow::includeMask::includeMask
+(
+	const dictionary& dict, 
+	fieldsDataBase& fieldDB
+)
+:
+	database_(fieldDB)
+{}
+
+
+pFlow::uniquePtr<pFlow::includeMask> pFlow::includeMask::create
+(
+    const dictionary& opDict, 
+    fieldsDataBase& feildsDB
+)
+{
+	word mask = opDict.getValOrSet<word>("includeMask", "all");
+	word fieldType;
+	if( mask != "all")
+	{
+		auto& maskDict = opDict.subDict(mask+"Info");
+		word maskField = maskDict.getVal<word>("field");
+		
+		if( !feildsDB.getPointFieldType(maskField, fieldType) )
+		{
+			fatalErrorInFunction<<"Error in retriving the type of field"
+				<< maskField <<" from dictionary "
+				<< maskDict.globalName()
+				<< endl;
+			fatalExit;
+			return nullptr;
+		}
+	}
+	else
+	{
+		fieldType = getTypeName<real>();
+	}
+	
+	word method = angleBracketsNames2("IncludeMask", fieldType, mask);
+	
+	if( dictionaryvCtorSelector_.search(method) )
+	{
+		auto objPtr = 
+			dictionaryvCtorSelector_[method]
+			(opDict, feildsDB);
+		return objPtr;
+	}
+	else
+	{
+		printKeys
+		( 
+			fatalError << "Ctor Selector "<< 
+			method << " dose not exist. \n"
+			<<"Avaiable ones are: \n\n"
+			,
+			dictionaryvCtorSelector_
+		);
+		fatalExit;
+		return nullptr;
+	}
+	return nullptr;
+}
+
+
+	

src/PostprocessData/operation/includeMask/includeMask.hpp

@@ -0,0 +1,115 @@
+/*------------------------------- 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 __includeMask_hpp__
+#define __includeMask_hpp__
+
+#include <vector> 
+
+#include "virtualConstructor.hpp"
+
+namespace pFlow
+{
+
+
+class fieldsDataBase;
+class dictionary;
+
+class includeMask
+{
+public:
+
+	class Mask
+	{
+		const std::vector<bool>& mask_;
+
+		public:
+
+		Mask(const std::vector<bool>& msk)
+		:
+			mask_(msk)
+		{}
+
+		Mask(const Mask&) = default;
+
+		Mask(Mask&&) = default;
+				
+		~Mask()=default;
+
+		auto size()const
+		{
+			return mask_.size();
+		}
+
+		bool operator()(uint32 i)const
+		{
+			return mask_[i];
+		}
+	};
+
+private:
+	
+    fieldsDataBase&     database_;
+	
+public:
+
+	TypeInfo("includeMask");
+
+	includeMask(const dictionary& opDict, fieldsDataBase& feildsDB);
+
+	virtual ~includeMask() = default;
+
+    create_vCtor
+    (
+        includeMask,
+        dictionary,
+        (
+            const dictionary& opDict, fieldsDataBase& feildsDB
+        ),
+        (opDict, feildsDB)		
+    );
+	 
+	const fieldsDataBase& database()const
+	{
+		return database_;
+	}
+
+    fieldsDataBase& database()
+    {
+        return database_;
+    }
+
+    virtual 
+    Mask getMask()= 0;
+
+	static 
+	uniquePtr<includeMask> create(
+        const dictionary& opDict, 
+        fieldsDataBase& feildsDB);
+	
+};
+
+
+
+} // pFlow
+
+#endif //__IncludeMask_hpp__
+
+

src/PostprocessData/operation/includeMask/maskOperations.hpp

@@ -0,0 +1,162 @@
+
+#ifndef __maskOperation_hpp__
+#define __maskOperation_hpp__
+
+#include "types.hpp"
+#include "dictionary.hpp"
+
+namespace pFlow
+{
+
+template<typename T>
+struct greaterThanOp
+{
+	TypeInfoNV("greaterThan");
+
+ 	inline
+ 	bool operator()(const T &compVal, const T &val) const {
+   		return val > compVal; }
+};
+
+template<typename T>
+struct greaterThanEqOp
+{
+	TypeInfoNV("greaterThanEq");
+
+ 	inline
+ 	bool operator()(const T &compVal, const T &val) const {
+   		return val >= compVal; }
+};
+
+template<typename T>
+struct lessThanOp
+{
+	TypeInfoNV("lessThan");
+
+	inline
+	bool operator()(const T &compVal, const T &val) const {
+		return val < compVal; }
+};
+
+template<typename T>
+struct lessThanEqOp
+{
+	TypeInfoNV("lessThanEq");
+
+	inline
+	bool operator()(const T &compVal, const T &val) const {
+		return val <= compVal; }
+};
+
+template<typename T>
+struct equalOp
+{
+	TypeInfoNV("equal");
+
+	inline
+	bool operator()(const T &compVal, const T &val) const {
+		return equal(val , compVal); }
+};
+
+
+template<typename T>
+struct betweenOp
+{
+	TypeInfoNV("between");
+
+	inline
+	bool operator()(const T &compVal1, const T &compVal2 ,const T &val) const {
+		return val>compVal1 && val<compVal2; }
+};
+
+
+template<typename T>
+struct betweenEqOp
+{
+	TypeInfoNV("betweenEq");
+
+	inline
+	bool operator()(const T &compVal1, const T &compVal2 ,const T &val) const {
+		return val>=compVal1 && val<=compVal2; }
+};
+
+template<typename T>
+struct allOp
+{
+	TypeInfoNV("all");
+
+	inline
+	bool operator()() const {return true; }
+};
+
+
+
+template<typename T, template<class> class Operator>
+class compareOne
+{
+public:
+
+	using opertorType = Operator<T>;
+
+protected:
+	T 				compValue_{};
+	opertorType 	operator_{};
+public:
+
+	TypeInfoNV(Operator<T>::TYPENAME());
+
+	compareOne(const dictionary& dict)
+	:
+		compValue_(dict.getVal<T>("value"))
+	{}
+
+	bool operator()(const T& value)const
+	{
+		return operator_(compValue_, value);
+	}
+};
+
+template<typename T, template<class> class Operator>
+class compareTwo
+{
+public:
+	using opertorType = Operator<T>;
+protected:
+	T 				compValue1_;
+	T  				compValue2_;
+	opertorType 	operator_{};
+public:
+	
+	TypeInfoNV(opertorType::TYPENAME());
+
+	compareTwo(const dictionary& dict)
+	:
+		compValue1_(dict.getVal<T>("value1")),
+		compValue2_(dict.getVal<T>("value2"))
+	{}
+
+	bool operator()(const T& value)const
+	{
+		return operator_(compValue1_, compValue2_, value);
+	}
+};
+
+template<typename T, typename Operator>
+class compareZero
+{
+protected:
+	Operator 	operator_{};
+public:
+
+	TypeInfoNV(Operator::TYPENAME());
+	compareZero(const dictionary& dict);
+
+	bool operator()(const T& value) const
+	{
+		return operator_();
+	}
+};
+
+}
+
+#endif //__maskOperation_hpp__