preCICE v3.1.2
Loading...
Searching...
No Matches
Classes | Typedefs | Functions | Variables
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
 Stores a mesh and related objects and data. More...
 
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...
 
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...
 
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 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)
 
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

◆ PtrCoupling

Definition at line 15 of file SharedPointer.hpp.

◆ PtrMeshContext

Definition at line 18 of file SharedPointer.hpp.

◆ PtrParticipant

Definition at line 14 of file SharedPointer.hpp.

◆ PtrWatchIntegral

Definition at line 17 of file SharedPointer.hpp.

◆ PtrWatchPoint

Definition at line 16 of file SharedPointer.hpp.

Function Documentation

◆ errorInvalidVertexID()

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

Definition at line 7 of file CommonErrorMessages.hpp.

Here is the call graph for this function:

◆ 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 323 of file preciceFortran.cpp.

◆ strippedStringView()

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

Definition at line 334 of file preciceFortran.cpp.

Here is the call graph for this function:

Variable Documentation

◆ errorInvalidVertexIDRange

constexpr 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.