precice::impl Namespace Reference

Classes
class	DataContext
	Stores one Data object with related mesh. More...
struct	MappingContext
	Holds a data mapping and related information. More...
struct	MeshContext
struct	MeshDataKey
	Type that represent a compound key of two values. More...
class	ParticipantImpl
	Implementation of Participant. See also pimpl ideom (https://en.cppreference.com/w/cpp/language/pimpl). More...
class	ParticipantState
	Holds coupling state of one participating solver in coupled simulation. More...
struct	ProvidedMeshContext
	Context for a mesh provided by this participant. More...
class	ReadDataContext
	Stores one Data object with related mesh. Context stores data to be read from and potentially provides a read mapping. Additionally stores Waveform object associated with _providedData. More...
struct	ReceivedMeshContext
	Context for a mesh received from another participant. More...
class	WatchIntegral
	Track and output transient integral data on a mesh. More...
class	WatchPoint
	Observes and exports coordinates of a point on the geometry. More...
class	WriteDataContext
	Stores one Data object with related mesh. Context stores data to be written to and potentially provides a write mapping. More...

Typedefs
using	MeshContextVariant = std::variant<ProvidedMeshContext *, ReceivedMeshContext *>
	Type alias for variant holding either provided or received mesh context pointers.
using	PtrParticipant = std::shared_ptr<ParticipantState>
using	PtrCoupling = std::shared_ptr<Coupling>
using	PtrWatchPoint = std::shared_ptr<WatchPoint>
using	PtrWatchIntegral = std::shared_ptr<WatchIntegral>
using	PtrMeshContext = std::shared_ptr<MeshContext>

Functions
std::string	errorInvalidVertexID (int vid)
MeshContext *	getMeshContext (const MeshContextVariant &variant)
	Helper to extract base MeshContext pointer from variant.
mesh::Mesh &	getMesh (const MeshContextVariant &variant)
	Helper to extract mesh from variant.
partition::Partition &	getPartition (const MeshContextVariant &variant)
	Helper to extract partition from variant.
template<class T>
	MeshDataKey (T, T) -> MeshDataKey< T >
	Deduction guide for two identical parameter types.
int	strippedLength (const char *string, int length)
	Returns length of string without trailing whitespace.
std::string_view	strippedStringView (const char *string, int length)

Variables
static constexpr auto	errorInvalidVertexIDRange = "The given range of VertexIDs contains invalid IDs at offsets [{},{}]. Check that they originated from calls to setMeshVertex() or setMeshVertices()."

Typedef Documentation

MeshContextVariant

using precice::impl::MeshContextVariant = std::variant<ProvidedMeshContext *, ReceivedMeshContext *>

Type alias for variant holding either provided or received mesh context pointers.

Definition at line 35 of file ParticipantState.hpp.

PtrCoupling

using precice::impl::PtrCoupling = std::shared_ptr<Coupling>

Definition at line 14 of file SharedPointer.hpp.

PtrMeshContext

using precice::impl::PtrMeshContext = std::shared_ptr<MeshContext>

Definition at line 17 of file SharedPointer.hpp.

PtrParticipant

using precice::impl::PtrParticipant = std::shared_ptr<ParticipantState>

Definition at line 13 of file SharedPointer.hpp.

PtrWatchIntegral

using precice::impl::PtrWatchIntegral = std::shared_ptr<WatchIntegral>

Definition at line 16 of file SharedPointer.hpp.

PtrWatchPoint

using precice::impl::PtrWatchPoint = std::shared_ptr<WatchPoint>

Definition at line 15 of file SharedPointer.hpp.

Function Documentation

errorInvalidVertexID()

std::string precice::impl::errorInvalidVertexID ( int vid )

inline

Definition at line 7 of file CommonErrorMessages.hpp.

getMesh()

mesh::Mesh & precice::impl::getMesh ( const MeshContextVariant & variant )

inline

Helper to extract mesh from variant.

Definition at line 44 of file ParticipantState.hpp.

getMeshContext()

MeshContext * precice::impl::getMeshContext ( const MeshContextVariant & variant )

inline

Helper to extract base MeshContext pointer from variant.

Definition at line 38 of file ParticipantState.hpp.

getPartition()

partition::Partition & precice::impl::getPartition ( const MeshContextVariant & variant )

inline

Helper to extract partition from variant.

Definition at line 50 of file ParticipantState.hpp.

MeshDataKey()

template<class T>

precice::impl::MeshDataKey	(	T	,
		T	) -> MeshDataKey< T >

Deduction guide for two identical parameter types.

strippedLength()

int precice::impl::strippedLength	(	const char *	string,
		int	length )

Returns length of string without trailing whitespace.

Definition at line 422 of file preciceFortran.cpp.

strippedStringView()

std::string_view precice::impl::strippedStringView	(	const char *	string,
		int	length )

Definition at line 433 of file preciceFortran.cpp.

Here is the call graph for this function:

Variable Documentation

errorInvalidVertexIDRange

auto precice::impl::errorInvalidVertexIDRange = "The given range of VertexIDs contains invalid IDs at offsets [{},{}]. Check that they originated from calls to setMeshVertex() or setMeshVertices()."

staticconstexpr

Definition at line 12 of file CommonErrorMessages.hpp.