Utilities

Collaboration diagram for Utilities:

Classes
class	MPIUtils
	Utility class collecting functions requiring MPI synchronization. More...

Macros
#define	WRAPP_DEFINE_ENTITY_PROXY_FACTORY(TLocation, TEntity)

Typedefs
using	DataValueContainerKeyRange = Range< DataValueContainerKeyIterator >
	Range class iterating over the variable names within a DataValueContainer. More...
template<class TMap >
using	MapKeyRange = Range< MapKeyIterator< typename TMap::const_iterator > >
	Range class iterating over the keys of a standard-conforming map type. More...

Functions
template<Globals::DataLocation TLocation, class TEntity >
auto	MakeProxy (const TEntity &rEntity)
	Invalid template base to be specialized for valid template parameters. More...
template<Globals::DataLocation TLocation, class TEntity >
auto	MakeProxy (TEntity &rEntity)
	Invalid template base to be specialized for valid template parameters. More...
template<>
auto	MakeProxy< Globals::DataLocation::NodeHistorical, Node > (const Node &rEntity)
	Convenience function for constructing immutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::NodeHistorical, Node > (Node &rEntity)
	Convenience function for constructing mutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::NodeNonHistorical, Node > (const Node &rEntity)
	Convenience function for constructing immutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::NodeNonHistorical, Node > (Node &rEntity)
	Convenience function for constructing mutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::Element, Element > (const Element &rEntity)
	Convenience function for constructing immutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::Element, Element > (Element &rEntity)
	Convenience function for constructing mutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::Condition, Condition > (const Condition &rEntity)
	Convenience function for constructing immutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::Condition, Condition > (Condition &rEntity)
	Convenience function for constructing mutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::ProcessInfo, ProcessInfo > (const ProcessInfo &rEntity)
	Convenience function for constructing immutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::ProcessInfo, ProcessInfo > (ProcessInfo &rEntity)
	Convenience function for constructing mutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::ModelPart, ModelPart > (const ModelPart &rEntity)
	Convenience function for constructing immutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::ModelPart, ModelPart > (ModelPart &rEntity)
	Convenience function for constructing mutable EntityProxy instances. More...
template<>
auto	MakeProxy< Globals::DataLocation::ProcessInfo, ModelPart > (const ModelPart &rModelPart)
	Convenience function for constructing a mutable ProcessInfo proxy from a ModelPart. More...
template<>
auto	MakeProxy< Globals::DataLocation::ProcessInfo, ModelPart > (ModelPart &rModelPart)
	Convenience function for constructing an immutable ProcessInfo proxy from a ModelPart. More...
template<class TMap >
	MapKeyRange< TMap > (WR_APPLICATION) MakeConstMapKeyRange(const TMap &rMap)
	Create a view on the keys of an std::map or std::unordered_map. More...
template<class TIterator , class IsConstRange = void>
class Range	KRATOS_DEFINE_RANGE (TIterator,)
	Class representing a view into a subrange of a container. More...
template<class TIterator >
class Range< TIterator, typename std::enable_if< Detail::IsConstIterator< TIterator >::value >::type >	KRATOS_DEFINE_RANGE (TIterator, const)
	Class representing a view into a subrange of an immutable container. More...

Detailed Description

Macro Definition Documentation

WRAPP_DEFINE_ENTITY_PROXY_FACTORY

#define WRAPP_DEFINE_ENTITY_PROXY_FACTORY	(		TLocation,
			TEntity
	)

Value:

    \
    template <>                                                                                 \
    inline auto MakeProxy<TLocation,TEntity>(const TEntity& rEntity)                            \
    {return EntityProxy<TLocation,false>(rEntity);}                                             \      \
    template <>                                                                                 \
    inline auto MakeProxy<TLocation,TEntity>(TEntity& rEntity)                                  \
    {return EntityProxy<TLocation,true>(rEntity);}

Typedef Documentation

DataValueContainerKeyRange

using DataValueContainerKeyRange = Range<DataValueContainerKeyIterator>

Range class iterating over the variable names within a DataValueContainer.

MapKeyRange

using MapKeyRange = Range<MapKeyIterator<typename TMap::const_iterator> >

Range class iterating over the keys of a standard-conforming map type.

Function Documentation

KRATOS_DEFINE_RANGE() [1/2]

class Range< TIterator, typename std::enable_if< Detail::IsConstIterator< TIterator >::value >::type > Kratos::WRApp::KRATOS_DEFINE_RANGE	(	TIterator	,
		const
	)

Class representing a view into a subrange of an immutable container.

Template Parameters

TIterator

Iterator type of the target container.

KRATOS_DEFINE_RANGE() [2/2]

class Range Kratos::WRApp::KRATOS_DEFINE_RANGE

(

TIterator

)

Class representing a view into a subrange of a container.

Template Parameters

TIterator

Iterator type of the target container.

MakeProxy() [1/2]

auto Kratos::WRApp::MakeProxy ( const TEntity &  rEntity )

inline

Invalid template base to be specialized for valid template parameters.

MakeProxy() [2/2]

auto Kratos::WRApp::MakeProxy ( TEntity &  rEntity )

inline

Invalid template base to be specialized for valid template parameters.

MakeProxy< Globals::DataLocation::Condition, Condition >() [1/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::Condition, Condition > ( Condition &  rEntity )

inline

Convenience function for constructing mutable EntityProxy instances.

MakeProxy< Globals::DataLocation::Condition, Condition >() [2/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::Condition, Condition > ( const Condition &  rEntity )

inline

Convenience function for constructing immutable EntityProxy instances.

MakeProxy< Globals::DataLocation::Element, Element >() [1/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::Element, Element > ( const Element &  rEntity )

inline

Convenience function for constructing immutable EntityProxy instances.

MakeProxy< Globals::DataLocation::Element, Element >() [2/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::Element, Element > ( Element &  rEntity )

inline

Convenience function for constructing mutable EntityProxy instances.

MakeProxy< Globals::DataLocation::ModelPart, ModelPart >() [1/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::ModelPart, ModelPart > ( const ModelPart &  rEntity )

inline

Convenience function for constructing immutable EntityProxy instances.

MakeProxy< Globals::DataLocation::ModelPart, ModelPart >() [2/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::ModelPart, ModelPart > ( ModelPart &  rEntity )

inline

Convenience function for constructing mutable EntityProxy instances.

MakeProxy< Globals::DataLocation::NodeHistorical, Node >() [1/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::NodeHistorical, Node > ( const Node &  rEntity )

inline

Convenience function for constructing immutable EntityProxy instances.

MakeProxy< Globals::DataLocation::NodeHistorical, Node >() [2/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::NodeHistorical, Node > ( Node &  rEntity )

inline

Convenience function for constructing mutable EntityProxy instances.

MakeProxy< Globals::DataLocation::NodeNonHistorical, Node >() [1/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::NodeNonHistorical, Node > ( const Node &  rEntity )

inline

Convenience function for constructing immutable EntityProxy instances.

MakeProxy< Globals::DataLocation::NodeNonHistorical, Node >() [2/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::NodeNonHistorical, Node > ( Node &  rEntity )

inline

Convenience function for constructing mutable EntityProxy instances.

MakeProxy< Globals::DataLocation::ProcessInfo, ModelPart >() [1/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::ProcessInfo, ModelPart > ( const ModelPart &  rModelPart )

inline

Convenience function for constructing a mutable ProcessInfo proxy from a ModelPart.

MakeProxy< Globals::DataLocation::ProcessInfo, ModelPart >() [2/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::ProcessInfo, ModelPart > ( ModelPart &  rModelPart )

inline

Convenience function for constructing an immutable ProcessInfo proxy from a ModelPart.

MakeProxy< Globals::DataLocation::ProcessInfo, ProcessInfo >() [1/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::ProcessInfo, ProcessInfo > ( const ProcessInfo &  rEntity )

inline

Convenience function for constructing immutable EntityProxy instances.

MakeProxy< Globals::DataLocation::ProcessInfo, ProcessInfo >() [2/2]

auto Kratos::WRApp::MakeProxy< Globals::DataLocation::ProcessInfo, ProcessInfo > ( ProcessInfo &  rEntity )

inline

Convenience function for constructing mutable EntityProxy instances.

MapKeyRange< TMap >()

Kratos::WRApp::MapKeyRange< TMap >

(

WR_APPLICATION

)

const &

Create a view on the keys of an std::map or std::unordered_map.

Note

This is a convenience function to avoid having to specify template parameters.