Gs Namespace Reference

Classes
struct	allreduce_data
struct	array
struct	comm
struct	cr_data
struct	cr_stage
struct	gs_data
struct	gs_remote
struct	pw_comm_data
struct	pw_data

Typedefs
typedef array	buffer
typedef int	comm_ext
typedef int	comm_req
typedef void	exec_fun(void *data, gs_mode mode, unsigned vn, gs_dom dom, gs_op op, unsigned transpose, const void *execdata, const struct comm *comm, char *buf)
typedef void	fin_fun(void *data)

Enumerations
enum	gs_dom {   gs_double , gs_float , gs_int , gs_long ,   gs_dom_n }
enum	gs_op {   gs_add , gs_mul , gs_min , gs_max ,   gs_amax , gs_bpr , gs_op_n }
enum	gs_mode { mode_plain , mode_vec , mode_many , mode_dry_run }
enum	gs_method { gs_auto , gs_pairwise , gs_crystal_router , gs_all_reduce }

Functions
void	nektar_gs (void *u, gs_dom dom, gs_op op, unsigned transpose, gs_data *gsh, buffer *buf)
gs_data *	nektar_gs_setup (const long *id, unsigned int n, const struct comm *comm, int unique, gs_method method, int verbose)
void	nektar_gs_free (gs_data *gsh)
void	nektar_gs_unique (const long *id, unsigned int n, const struct comm *comm)
static gs_data *	Init (const Nektar::Array< OneD, long > &pId, const LibUtilities::CommSharedPtr &pComm, bool verbose=true)
	Initialise Gather-Scatter map. More...
static void	Unique (const Nektar::Array< OneD, long > &pId, const LibUtilities::CommSharedPtr &pComm)
	Updates pId to negate all-but-one references to each universal ID. More...
static void	Finalise (gs_data *pGsh)
	Deallocates the GSLib mapping data. More...
static void	Free (gs_data *pGsh)
	Deallocates GSLib mapping data without finalising MPI. More...
static void	Gather (Nektar::Array< OneD, NekDouble > pU, gs_op pOp, gs_data *pGsh, Nektar::Array< OneD, NekDouble > pBuffer=NullNekDouble1DArray)
	Performs a gather-scatter operation of the provided values. More...

Typedef Documentation

buffer

typedef array Gs::buffer

Definition at line 81 of file GsLib.hpp.

comm_ext

typedef int Gs::comm_ext

Definition at line 86 of file GsLib.hpp.

comm_req

typedef int Gs::comm_req

Definition at line 87 of file GsLib.hpp.

exec_fun

typedef void Gs::exec_fun(void *data, gs_mode mode, unsigned vn, gs_dom dom, gs_op op, unsigned transpose, const void *execdata, const struct comm *comm, char *buf)

Definition at line 135 of file GsLib.hpp.

fin_fun

typedef void Gs::fin_fun(void *data)

Definition at line 138 of file GsLib.hpp.

Enumeration Type Documentation

gs_dom

enum Gs::gs_dom

Enumerator
gs_double
gs_float
gs_int
gs_long
gs_dom_n

Definition at line 50 of file GsLib.hpp.

{
    gs_double,
    gs_float,
    gs_int,
    gs_long,
    gs_dom_n
} gs_dom;

gs_method

enum Gs::gs_method

Enumerator
gs_auto
gs_pairwise
gs_crystal_router
gs_all_reduce

Definition at line 157 of file GsLib.hpp.

{
    gs_auto,
    gs_pairwise,
    gs_crystal_router,
    gs_all_reduce
} gs_method;

gs_mode

enum Gs::gs_mode

Enumerator
mode_plain
mode_vec
mode_many
mode_dry_run

Definition at line 68 of file GsLib.hpp.

{
    mode_plain,
    mode_vec,
    mode_many,
    mode_dry_run
} gs_mode;

gs_op

enum Gs::gs_op

Enumerator
gs_add
gs_mul
gs_min
gs_max
gs_amax
gs_bpr
gs_op_n

Definition at line 58 of file GsLib.hpp.

{
    gs_add,
    gs_mul,
    gs_min,
    gs_max,
    gs_amax,
    gs_bpr,
    gs_op_n
} gs_op;

Function Documentation

Finalise()

static void Gs::Finalise ( gs_data *  pGsh )

inlinestatic

Deallocates the GSLib mapping data.

Definition at line 248 of file GsLib.hpp.

{
#ifdef NEKTAR_USE_MPI
    int finalized;
    MPI_Finalized(&finalized);
    if (pGsh && !finalized)
    {
        nektar_gs_free(pGsh);
    }
#endif
}

References nektar_gs_free().

Referenced by Nektar::MultiRegions::AssemblyMapCG::AssemblyMapCG(), Nektar::MultiRegions::AssemblyMapCG::CreateGraph(), export_SessionReader(), and Nektar::MultiRegions::AssemblyMapCG::~AssemblyMapCG().

Free()

static void Gs::Free ( gs_data *  pGsh )

inlinestatic

Deallocates GSLib mapping data without finalising MPI.

Definition at line 263 of file GsLib.hpp.

{
#ifdef NEKTAR_USE_MPI
    if (pGsh)
    {
        nektar_gs_free(pGsh);
    }
#endif
}

References nektar_gs_free().

Referenced by Nektar::MultiRegions::PreconditionerLowEnergy::v_BuildPreconditioner(), and Nektar::MultiRegions::PreconditionerBlock::~PreconditionerBlock().

Gather()

static void Gs::Gather ( Nektar::Array< OneD, NekDouble >  pU, gs_op  pOp, gs_data *  pGsh, Nektar::Array< OneD, NekDouble >  pBuffer = NullNekDouble1DArray  )

inlinestatic

Performs a gather-scatter operation of the provided values.

The

Definition at line 278 of file GsLib.hpp.

{
#ifdef NEKTAR_USE_MPI
    if (!pGsh)
    {
        return;
    }
    if (pBuffer.size() == 0)
    {
        nektar_gs(pU.data(), gs_double, pOp, false, pGsh, nullptr);
    }
    else
    {
        array buf;
        buf.ptr = &pBuffer[0];
        buf.n   = pBuffer.size();
        nektar_gs(pU.data(), gs_double, pOp, false, pGsh, &buf);
    }
#endif
}

References gs_double, Gs::array::n, nektar_gs(), and Gs::array::ptr.

Referenced by Nektar::MultiRegions::AssemblyMapCG::AssemblyMapCG(), Nektar::MultiRegions::PreconditionerBlock::BlockPreconditionerCG(), Nektar::MultiRegions::PreconditionerBlock::BlockPreconditionerHDG(), Nektar::MultiRegions::AssemblyMapCG::CreateGraph(), Nektar::PulseWaveSystem::EnforceInterfaceConditions(), Nektar::MultiRegions::AssemblyMap::LocalBndToGlobal(), Nektar::PulseWaveSystem::SetUpDomainInterfaces(), Nektar::MultiRegions::AssemblyMap::UniversalAbsMaxBnd(), Nektar::MultiRegions::AssemblyMap::UniversalAssembleBnd(), Nektar::MultiRegions::PreconditionerLowEnergy::v_BuildPreconditioner(), Nektar::MultiRegions::AssemblyMapCG::v_LocalToGlobal(), Nektar::MultiRegions::AssemblyMapCG::v_UniversalAssemble(), and Nektar::MultiRegions::AssemblyMapDG::v_UniversalAssemble().

Init()

static gs_data * Gs::Init ( const Nektar::Array< OneD, long > &  pId, const LibUtilities::CommSharedPtr &  pComm, bool  verbose = true  )

inlinestatic

Initialise Gather-Scatter map.

On each process an array of IDs for each global degree of freedom is supplied which corresponds to a unique numbering of universal degrees of freedom. This is used to initialise the GSLib mapping between process- boundary degrees of freedom on different processes.

Parameters

pId	Array of integers providing universal IDs for each global DOF on the process.
pComm	Communication object used for inter-process communication.

Returns

GSLib data structure containing mapping information.

Definition at line 190 of file GsLib.hpp.

{
#ifdef NEKTAR_USE_MPI
    if (pComm->IsSerial())
    {
        return nullptr;
    }
    LibUtilities::CommMpiSharedPtr vCommMpi =
        std::dynamic_pointer_cast<LibUtilities::CommMpi>(pComm);
    ASSERTL1(vCommMpi, "Failed to cast MPI Comm object.");
    comm vComm;
    MPI_Comm_dup(vCommMpi->GetComm(), &vComm.c);
    vComm.id        = vCommMpi->GetRank();
    vComm.np        = vCommMpi->GetSize();
    gs_data *result = nektar_gs_setup(pId.data(), pId.size(), &vComm, 0,
                                      gs_auto, (int)verbose);
    MPI_Comm_free(&vComm.c);
    return result;
#else
    return 0;
#endif
}

References ASSERTL1, Gs::comm::c, gs_auto, Gs::comm::id, nektar_gs_setup(), and Gs::comm::np.

Referenced by Nektar::MultiRegions::AssemblyMapCG::AssemblyMapCG(), Nektar::MultiRegions::PreconditionerBlock::BlockPreconditionerCG(), Nektar::MultiRegions::PreconditionerBlock::BlockPreconditionerHDG(), Nektar::CoupledAssemblyMap::CoupledAssemblyMap(), Nektar::MultiRegions::AssemblyMapCG::CreateGraph(), Nektar::PulseWaveSystem::SetUpDomainInterfaces(), Nektar::MultiRegions::AssemblyMapCG::SetUpUniversalC0ContMap(), Nektar::MultiRegions::AssemblyMapDG::SetUpUniversalDGMap(), Nektar::MultiRegions::PreconditionerLowEnergy::v_BuildPreconditioner(), and Nektar::MultiRegions::AssemblyMapCG::v_LinearSpaceMap().

nektar_gs()

void Gs::nektar_gs	(	void *	u,
		gs_dom	dom,
		gs_op	op,
		unsigned	transpose,
		gs_data *	gsh,
		buffer *	buf
	)

Referenced by Gather().

nektar_gs_free()

void Gs::nektar_gs_free

(

gs_data *

gsh

)

Referenced by Finalise(), and Free().

nektar_gs_setup()

gs_data * Gs::nektar_gs_setup	(	const long *	id,
		unsigned int	n,
		const struct comm *	comm,
		int	unique,
		gs_method	method,
		int	verbose
	)

Referenced by Init().

nektar_gs_unique()

void Gs::nektar_gs_unique	(	const long *	id,
		unsigned int	n,
		const struct comm *	comm
	)

Referenced by Unique().

Unique()

static void Gs::Unique ( const Nektar::Array< OneD, long > &  pId, const LibUtilities::CommSharedPtr &  pComm  )

inlinestatic

Updates pId to negate all-but-one references to each universal ID.

The array of universal IDs corresponding to the process-local DOF are updated such that the ID of only one instance of each universal ID remains positive. This allows the consistent formulation of universally -distributed dot products, for which the contributions of each DOF must be included only once.

Definition at line 225 of file GsLib.hpp.

{
#ifdef NEKTAR_USE_MPI
    if (pComm->IsSerial())
    {
        return;
    }
    LibUtilities::CommMpiSharedPtr vCommMpi =
        std::dynamic_pointer_cast<LibUtilities::CommMpi>(pComm);
    ASSERTL1(vCommMpi, "Failed to cast MPI Comm object.");
    comm vComm;
    vComm.c  = vCommMpi->GetComm();
    vComm.id = vCommMpi->GetRank();
    vComm.np = vCommMpi->GetSize();
    nektar_gs_unique(pId.data(), pId.size(), &vComm);
#endif
}

References ASSERTL1, Gs::comm::c, Gs::comm::id, nektar_gs_unique(), and Gs::comm::np.

Referenced by Nektar::CoupledAssemblyMap::CoupledAssemblyMap(), Nektar::MultiRegions::AssemblyMapCG::SetUpUniversalC0ContMap(), Nektar::MultiRegions::AssemblyMapDG::SetUpUniversalDGMap(), and Nektar::MultiRegions::AssemblyMapCG::v_LinearSpaceMap().