domain_util.h

# ifndef __util__domain_util__h__ 
# define __util__domain_util__h__ 

// UG4 base libs.
#include "common/common.h"
#include "common/log.h"
#include "common/util/smart_pointer.h"


#include "lib_grid/refinement/refiner_factory.hpp"
#include "lib_grid/algorithms/problem_detection_util.h" // CheckForUnconnectedSides


#include "lib_disc/domain.h"
#include "lib_disc/domain_util.h"

// C++ libs.
#include <vector>
#include <string>

namespace ug {
namespace Util {

namespace aux {
	template <typename TObject>
	void write(TObject &text) { UG_LOG(text); }
}

using aux::write;

// util.CheckSubsets
// checks if all required subsets are contained in the SubsetHandler
// @param dom Domain
// @param neededSubsets List of subsets the SubsetHandler must contain
// @return true if all subsets are contained, false else

template <typename TDomain>
bool CheckSubsets(const TDomain &dom, const std::vector<std::string> &neededSubsets)
{
	auto sh = dom.subset_handler();
	
    for (auto &subset : neededSubsets) {
		if (sh->get_subset_index(subset.c_str()) == -1)  {
			UG_LOG("Domain does not contain subset '" << subset.c_str() <<"'.");
			return false;
		}
    }
	
	return true;
}


// Creates a new domain and loads the specified grid.
// The method then performs numRefs global refinements.
// A list of subset-names can be specified which have to be present in the loaded grid.
// The method returns the created domain.
// @note Some paramters are optional. nil is a valid value for each optional parameter.
// @return	(Domain) the created domain
// @param gridName	(string) The filename of the grid which shall be loaded.
//					The grid is searched in a path relative to the current path
//					first. If it isn't found there, the path is interpreted as
//					an absolute path. If the grid still can't be found, the method
//					tries to load it from UG_BASE/data/grids.
// @param numRefs	(int) The total number of global refinements
// @param neededSubsets	(optional, list of strings) The subsets that are required
//							by the simulation. If not all those subsets are present,
//							the method aborts. Default is an empty list.
// @param noIntegrityCheck	(optional, bool) Disables integrity check if 'true'.


template <typename TDomain>
SmartPtr<TDomain> CreateDomain(const std::string &gridName, int numRefs,
		const std::vector<std::string> &neededSubsets, bool noIntegrityCheck=false) {

	// Create domain instance.
	auto dom = make_sp<TDomain>(new TDomain());

	// load domain
	UG_LOG("Loading Domain " << gridName << " ... ")
	LoadDomain(*dom, gridName.c_str()); // from lib_disc/domain_util.cpp
	UG_LOG("done." << std::endl)


	if (noIntegrityCheck == false) {
		UG_LOG("Performing integrity check on domain ... ");
		if (CheckForUnconnectedSides(*dom->grid()))
		{
			UG_LOG("WARNING: unconnected sides found (see above).\n");
			std::string note("NOTE: You may disable this check by passing 'true' to 'noIntegrityCheck' in 'util.CreateDomain'.\n");
			UG_LOG(note);
			UG_ERR_LOG(note);
		}
		UG_LOG("done.\n");
    }

	// Create a refiner instance. This is a factory method
	// which automatically creates a parallel refiner if required.
	// if numRefs == nil then numRefs = 0 end
	if (numRefs > 0) {
		UG_LOG("Refining(" << numRefs << "): ");
		auto refiner = GlobalDomainRefiner(*dom);
		for (int i=0; i<numRefs; ++i){
			// TerminateAbortedRun();
			refiner->refine();
			UG_LOG(i << " ");
		}
		UG_LOG("done.\n");
		// delete(refiner)
	}

	// check whether required subsets are present
	if (!neededSubsets.empty())
	{

		UG_ASSERT(CheckSubsets(*dom, neededSubsets) == true,
			"Something wrong with required subsets. Aborting.");
	}

	// return the created domain
	return dom;
}


template <typename TDomain>
SmartPtr<TDomain> CreateDomain(const std::string &gridName, int numRefs, const std::vector<std::string> &neededSubsets)
{ 
    return CreateDomain<TDomain>(gridName, numRefs, neededSubsets, false);
}

template <typename TDomain>
SmartPtr<TDomain> CreateDomain(const std::string &gridName, int numRefs)
{ 
    return CreateDomain<TDomain>(gridName,numRefs, std::vector<std::string>(), false);
}

template <typename TDomain>
SmartPtr<TDomain> CreateDomain(const std::string &gridName)
{

    return CreateDomain<TDomain>(gridName, 0, std::vector<std::string>(), false);
}


// Creates a new domain and loads the specified grid. The method then performs
// numPreRefs refinements before it distributes the domain onto the available
// processes. The partitioning method can be chosen through distributionMethod.
// After distribution the domain is refined until a total of numRefs refinement
// steps has been performed (including numPreRefs).
// A list of subset-names can be specified. After distribution the methods checks
// Whether all processes received the required subsets.
// The method returns the created domain.
// @note Some paramters are optional. nil is a valid value for each optional parameter.
// @return	(Domain) the created domain
// @param gridName	(string) The filename of the grid which shall be loaded.
//					The grid is searched in a path relative to the current path
//					first. If it isn't found there, the path is interpreted as
//					an absolute path. If the grid still can't be found, the method
//					tries to load it from UG_BASE/data/grids.
// @param numRefs	(int) The total number of global refinements
// @param numPreRefs	(int) The number of refinements that are performed before
//						distribution.
// @param neededSubsets	(optional, list of strings) The subsets that are required
//							by the simulation. If not all those subsets are present,
//							the method aborts. Default is an empty list.
// @param distributionMethod	(optional, string) The distribution method.
//								Either "bisection" or "metis". Default is "bisection".
//								See util.DistributeDomain for more information
//								(in UG_BASE/scripts/util/domain_distribution.lua)
// @param verticalInterfaces	(optional, bool) Vertical interfaces are required
//								by multi-grid solvers. Default is true.
//								See util.DistributeDomain for more information
//								(in UG_BASE/scripts/util/domain_distribution.lua)
// @param numTargetProcs	(optional, int) The number of target processes to which
//							the domain shall be distributed. Make sure that the
//							number of target processes is not higher than the
//							number of elements in the distributionLevel.
//							Default is NumProcs()
//							See util.DistributeDomain for more information
//							(in UG_BASE/scripts/util/domain_distribution.lua)
// @param distributionLevel	(optional, int) The level on which the distribution
//								is performed. Default is the domains top-level
//								after pre-refinement.
//								See util.DistributeDomain for more information
//								(in UG_BASE/scripts/util/domain_distribution.lua)
// @param wFct 			(optional SmartPtr\<EdgeWeighting\>) Sets the weighting function for the
//							'metisReweigh' partitioning method.
// @param noIntegrityCheck	(optional, bool) Disables integrity check if 'true'.

/*function util.CreateAndDistributeDomain(gridName, numRefs, numPreRefs,
										neededSubsets, distributionMethod,
										verticalInterfaces, numTargetProcs,
										distributionLevel, wFct, noIntegrityCheck)

	// create Instance of a Domain
	local dom = Domain()
	
	// load domain
	write("Loading Domain "..gridName.." ... ") 
	LoadDomain(dom, gridName)
	write("done.\n")
	
	if noIntegrityCheck ~= true then
		write("Performing integrity check on domain ... ")
		if CheckForUnconnectedSides(dom:grid()) == true then
			write("WARNING: unconnected sides found (see above).\n")
			local note = "NOTE: You may disable this check by passing 'true' "..
				  		 "to 'noIntegrityCheck' in 'util.CreateAndDistributeDomain'.\n"
			write(note)
			errlog(note)
		end
		write("done.\n")
	end

	// create Refiner
	ug_assert(numPreRefs <= numRefs, "numPreRefs must be smaller than numRefs. Aborting.");
	
	if numPreRefs > numRefs then
		numPreRefs = numRefs
	end
	
	// Create a refiner instance. This is a factory method
	// which automatically creates a parallel refiner if required.
	local refiner = nil
	if numRefs > 0 then
		refiner = GlobalDomainRefiner(dom)
	end
	
	write("Pre-Refining("..numPreRefs.."): ")
	// Performing pre-refines
	for i=1,numPreRefs do
		TerminateAbortedRun()
		write(i .. " ")
		refiner:refine()
	end
	write("done.\nDistributing...")
	// Distribute the domain to all involved processes
	if util.DistributeDomain(dom, distributionMethod, verticalInterfaces, numTargetProcs, distributionLevel, wFct) == false then
		ug_error("Error while Distributing Grid. Aborting.")
	end
	write(" done.\nPost-Refining("..(numRefs-numPreRefs).."): ")
	
	if numRefs > 0 then
		// Perform post-refine
		for i=numPreRefs+1,numRefs do
			TerminateAbortedRun()
			refiner:refine()
			write(i-numPreRefs .. " ")
		end
	end
	write("done.\n")
	
	// Now we loop all subsets an search for it in the SubsetHandler of the domain
	if neededSubsets ~= nil then
		if util.CheckSubsets(dom, neededSubsets) == false then 
			ug_error("Something wrong with required subsets. Aborting.");
		end
	end
	
	
	//clean up
	if refiner ~= nil then
		delete(refiner)
	end
	
	// return the created domain
	return dom
end
*/
} // namespace util
} // namespace ug

# endif //__util__domain_util__h__