atlas::Redistribution Class Reference

Base redistributer class. More...

#include <Redistribution.h>

Inheritance diagram for atlas::Redistribution:

Collaboration diagram for atlas::Redistribution:

Public Member Functions
	Redistribution ()
	Empty default constructor.
	Redistribution (const FunctionSpace &sourceFunctionSpace, const FunctionSpace &targetFunctionSpace)
	Constructs and initialises the redistributor. More...
void	execute (const Field &sourceField, Field &targetField) const
	Maps source field to target field. More...
void	execute (const FieldSet &sourceFieldSet, FieldSet &targetFieldSet) const
	Redistributes source field set to target fields set. More...
FunctionSpace &	source ()
	Get reference to source function space.
const FunctionSpace &	source () const
	Get const reference to source function space.
FunctionSpace &	target ()
	Get reference to taget function space.
const FunctionSpace &	target () const
	Get const reference to target function space.
Public Member Functions inherited from atlas::util::ObjectHandle< redistribution::detail::RedistributionImpl >
	ObjectHandle (const redistribution::detail::RedistributionImpl *object)
	ObjectHandle (const ObjectHandle &handle)
ObjectHandle &	operator= (const ObjectHandle &handle)
ATLAS_ALWAYS_INLINE redistribution::detail::RedistributionImpl *	get ()
ATLAS_ALWAYS_INLINE const redistribution::detail::RedistributionImpl *	get () const
ATLAS_ALWAYS_INLINE const redistribution::detail::RedistributionImpl *	operator-> () const
ATLAS_ALWAYS_INLINE redistribution::detail::RedistributionImpl *	operator-> ()
ATLAS_ALWAYS_INLINE const redistribution::detail::RedistributionImpl &	operator* () const
ATLAS_ALWAYS_INLINE redistribution::detail::RedistributionImpl &	operator* ()
ATLAS_ALWAYS_INLINE void	reset (const redistribution::detail::RedistributionImpl *object)
Public Member Functions inherited from atlas::util::ObjectHandleBase
	ObjectHandleBase (const Object *object)
const ObjectHandleBase &	operator= (const ObjectHandleBase &other)
	operator bool () const
void	reset (const Object *other)
int	owners () const

Additional Inherited Members
Public Types inherited from atlas::util::ObjectHandle< redistribution::detail::RedistributionImpl >
using	Implementation = redistribution::detail::RedistributionImpl
using	Handle = ObjectHandle< redistribution::detail::RedistributionImpl >
Protected Attributes inherited from atlas::util::ObjectHandleBase
Object *	object_ {nullptr}

Detailed Description

Base redistributer class.

Class to map two function spaces with the same grid but different partitioners.

Constructor & Destructor Documentation

Redistribution()

atlas::Redistribution::Redistribution	(	const FunctionSpace &	sourceFunctionSpace,
		const FunctionSpace &	targetFunctionSpace
	)

Constructs and initialises the redistributor.

Initialises class to copy fields from a source function space to fields from a target functionspace. The grids of source and target function space must match.

Parameters

[in]	sourceFunctionSpace	Function space of source fields.
[in]	targetFunctionSpace	Function space of target fields.

Member Function Documentation

execute() [1/2]

void atlas::Redistribution::execute	(	const Field &	sourceField,
		Field &	targetField
	)		const

Maps source field to target field.

Transfers data from source field to target field. Function space of source field must match sourceFunctionSpace. Same applies to target field.

Parameters

[in]	sourceField	input field matching sourceFunctionSpace.
[out]	targetField	output field matching targetFunctionSpace.

execute() [2/2]

void atlas::Redistribution::execute	(	const FieldSet &	sourceFieldSet,
		FieldSet &	targetFieldSet
	)		const

Redistributes source field set to target fields set.

Transfers source field set to target field set via multiple invocations of execute(sourceField, targetField).

Parameters

[in]	sourceFieldSet	input field set.
[out]	targetFieldSet	output field set.

---

The documentation for this class was generated from the following files:

• src/atlas/redistribution/Redistribution.h
• src/atlas/redistribution/Redistribution.cc