Holds coupling state of one participating solver in coupled simulation. More...

#include <ParticipantState.hpp>

Collaboration diagram for precice::impl::ParticipantState:

Classes
struct	IntermediateExport

Public Types
enum	MappingConstants { MAPPING_LINEAR_CONSERVATIVE , MAPPING_LINEAR_CONSISTENT , MAPPING_DIRECT }

Public Member Functions
	ParticipantState (std::string name, mesh::PtrMeshConfiguration &meshConfig)
	Constructor.
void	initializeMappingDataCache (std::string_view mappingType)
	Initializes the MappingDataCache in the DataContext after having computed the mappings.
void	configureInputMeshContext (std::string_view fromMesh, impl::MappingContext &mappingContext, mapping::Mapping::MeshRequirement requirement)
	Configures the mesh context with connectivity requirements and adds it to the mappingcontext.
void	configureOutputMeshContext (std::string_view toMesh, impl::MappingContext &mappingContext, mapping::Mapping::MeshRequirement requirement)
	Configures the mesh context with connectivity requirements and adds it to the mappingcontext.
Configuration interface
Adds a configured write Data to the ParticipantState
void	addWriteData (const mesh::PtrData &data, const mesh::PtrMesh &mesh)
void	addReadData (const mesh::PtrData &data, const mesh::PtrMesh &mesh)
	Adds a configured read Data to the ParticipantState.
void	addReadMappingContext (const MappingContext &mappingContext)
	Adds a configured read Mapping to the ParticipantState.
void	addWriteMappingContext (const MappingContext &mappingContext)
	Adds a configured write Mapping to the ParticipantState.
void	addWatchPoint (const PtrWatchPoint &watchPoint)
	Adds a configured WatchPoint to the ParticipantState.
void	addWatchIntegral (const PtrWatchIntegral &watchIntegral)
	Adds a configured WatchIntegral to the ParticipantState.
void	setUsePrimaryRank (bool useIntraComm)
	Sets weather the participant was configured with a primary tag.
void	addAction (action::PtrAction &&action)
	Adds a configured Action to the participant.
void	addExportContext (const io::ExportContext &context)
	Adds a configured ExportContext to export meshes and data.
void	provideMesh (mesh::PtrMesh mesh)
	Adds a mesh to be provided by the participant.
void	receiveMesh (mesh::PtrMesh mesh, const std::string &fromParticipant, double safetyFactor, partition::ReceivedPartition::GeometricFilter geoFilter, const bool allowDirectAccess)
	Adds a mesh to be received by the participant.
Data queries
const ReadDataContext &	readDataContext (std::string_view mesh, std::string_view data) const
ReadDataContext &	readDataContext (std::string_view mesh, std::string_view data)
mesh::PtrMesh	findMesh (std::string_view data) const
	Returns the mesh associated with ReadDataContext with given data name in _readDataContexts of this Participant.
const WriteDataContext &	writeDataContext (std::string_view mesh, std::string_view data) const
WriteDataContext &	writeDataContext (std::string_view mesh, std::string_view data)
auto	writeDataContexts ()
auto	readDataContexts ()
bool	hasData (std::string_view mesh, std::string_view data) const
	Is the dataID know to preCICE?
bool	isDataUsed (std::string_view mesh, std::string_view data) const
	Is the data used by this participant?
bool	isDataRead (std::string_view mesh, std::string_view data) const
	Is the participant allowed to read the data?
bool	isDataWrite (std::string_view mesh, std::string_view data) const
	Is the participant allowed to write the data?
Mesh queries
const MeshContext &	meshContext (std::string_view mesh) const
	Mesh queries.
MeshContext &	meshContext (std::string_view mesh)
const std::vector< MeshContextVariant > &	usedMeshContexts () const
std::vector< MeshContextVariant > &	usedMeshContexts ()
bool	hasMesh (std::string_view mesh) const
	Does preCICE know a mesh with this name?
bool	isMeshUsed (std::string_view mesh) const
	Is a mesh with this name used by this participant?
bool	isMeshProvided (std::string_view mesh) const
	Is a mesh with this name provided by this participant?
bool	isMeshReceived (std::string_view mesh) const
	Is a mesh with this name received by this participant?
bool	isDirectAccessAllowed (std::string_view mesh) const
ReceivedMeshContext &	receivedMeshContext (std::string_view mesh)
const ReceivedMeshContext &	receivedMeshContext (std::string_view mesh) const
ProvidedMeshContext &	providedMeshContext (std::string_view mesh)
const ProvidedMeshContext &	providedMeshContext (std::string_view mesh) const
std::deque< ProvidedMeshContext > &	providedMeshContexts ()
const std::deque< ProvidedMeshContext > &	providedMeshContexts () const
std::deque< ReceivedMeshContext > &	receivedMeshContexts ()
const std::deque< ReceivedMeshContext > &	receivedMeshContexts () const
Exporting interface
Exports the initial state of meshes
void	exportInitial ()
void	exportIntermediate (IntermediateExport exp)
	Exports timewindows and iterations of meshes and watchpoints.
Other queries
Returns the name of the participant.
const std::string &	getName () const
bool	useIntraComm () const
	Returns true, if the participant uses a primary tag.
bool	hasReadMappings () const
	Returns true, if the participant has at least one read mapping.
bool	hasWriteMappings () const
	Returns true, if the participant has at least one write mapping.
std::vector< MappingContext > &	readMappingContexts ()
	Provided access to all read MappingContext.
std::vector< MappingContext > &	writeMappingContexts ()
	Provided access to all write MappingContext.
std::vector< PtrWatchPoint > &	watchPoints ()
	Provided access to all WatchPoints.
std::vector< PtrWatchIntegral > &	watchIntegrals ()
	Provided access to all WatchIntegrals.
std::vector< action::PtrAction > &	actions ()
	Provided access to all Action.
const std::vector< action::PtrAction > &	actions () const
	Provided access to all Action.
const std::vector< io::ExportContext > &	exportContexts () const
	Returns all ExportContext for exporting meshes and data.
bool	hasExports () const
	Returns true, if the participant has any exports enabled.
Error helpers
std::string	hintForMesh (std::string_view mesh) const
std::string	hintForMeshData (std::string_view mesh, std::string_view data) const

Private Types
template<typename T>
using	MeshMap = std::map<std::string, T, std::less<>>
template<typename T>
using	DataMap = std::map<MeshDataKey<std::string>, T, std::less<>>

Private Member Functions
template<typename ELEMENT_T>
bool	isDataValid (const std::vector< ELEMENT_T > &data, const ELEMENT_T &newElement) const
void	checkDuplicatedUse (std::string_view mesh)
void	checkDuplicatedData (std::string_view mesh, std::string_view data)

Private Attributes
logging::Logger	_log {"impl::ParticipantState"}
std::string	_name
std::vector< PtrWatchPoint >	_watchPoints
std::vector< PtrWatchIntegral >	_watchIntegrals
std::vector< io::ExportContext >	_exportContexts
	Export contexts to export meshes, data, and more.
std::vector< action::PtrAction >	_actions
MeshMap< MeshContext * >	_meshContexts
	All mesh contexts involved in a simulation (for name-based lookup)
std::deque< ProvidedMeshContext >	_providedMeshContexts
	Provided mesh contexts (owning container)
std::deque< ReceivedMeshContext >	_receivedMeshContexts
	Received mesh contexts (owning container)
std::vector< MappingContext >	_readMappingContexts
	Read mapping contexts used by the participant.
std::vector< MappingContext >	_writeMappingContexts
	Write mapping contexts used by the participant.
std::vector< MeshContextVariant >	_usedMeshContexts
	Mesh contexts used by the participant.
DataMap< WriteDataContext >	_writeDataContexts
DataMap< ReadDataContext >	_readDataContexts
bool	_useIntraComm = false

Friends
struct	Integration::Serial::Whitebox::TestConfigurationPeano
	To allow white box tests.
struct	Integration::Serial::Whitebox::TestConfigurationComsol

Detailed Description

Holds coupling state of one participating solver in coupled simulation.

Definition at line 95 of file ParticipantState.hpp.

Member Typedef Documentation

◆ DataMap

template<typename T>

using precice::impl::ParticipantState::DataMap = std::map<MeshDataKey<std::string>, T, std::less<>>

private

Definition at line 396 of file ParticipantState.hpp.

◆ MeshMap

template<typename T>

using precice::impl::ParticipantState::MeshMap = std::map<std::string, T, std::less<>>

private

Definition at line 393 of file ParticipantState.hpp.

Member Enumeration Documentation

◆ MappingConstants

enum precice::impl::ParticipantState::MappingConstants

Enumerator
MAPPING_LINEAR_CONSERVATIVE
MAPPING_LINEAR_CONSISTENT
MAPPING_DIRECT

Definition at line 97 of file ParticipantState.hpp.

Constructor & Destructor Documentation

◆ ParticipantState()

precice::impl::ParticipantState::ParticipantState	(	std::string	name,
		mesh::PtrMeshConfiguration &	meshConfig )

Constructor.

Parameters

[in] name Name of the participant. Has to be unique.

Definition at line 29 of file ParticipantState.cpp.

Member Function Documentation

◆ actions() [1/2]

std::vector< action::PtrAction > & precice::impl::ParticipantState::actions ( )

Provided access to all Action.

Definition at line 333 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ actions() [2/2]

const std::vector< action::PtrAction > & precice::impl::ParticipantState::actions ( ) const

Provided access to all Action.

Definition at line 338 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ addAction()

void precice::impl::ParticipantState::addAction ( action::PtrAction && action )

Adds a configured Action to the participant.

Configuration interface.

Definition at line 38 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ addExportContext()

void precice::impl::ParticipantState::addExportContext ( const io::ExportContext & context )

Adds a configured ExportContext to export meshes and data.

Definition at line 343 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ addReadData()

void precice::impl::ParticipantState::addReadData	(	const mesh::PtrData &	data,
		const mesh::PtrMesh &	mesh )

Adds a configured read Data to the ParticipantState.

Definition at line 106 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ addReadMappingContext()

void precice::impl::ParticipantState::addReadMappingContext ( const MappingContext & mappingContext )

Adds a configured read Mapping to the ParticipantState.

Definition at line 114 of file ParticipantState.cpp.

◆ addWatchIntegral()

void precice::impl::ParticipantState::addWatchIntegral ( const PtrWatchIntegral & watchIntegral )

Adds a configured WatchIntegral to the ParticipantState.

Definition at line 56 of file ParticipantState.cpp.

◆ addWatchPoint()

void precice::impl::ParticipantState::addWatchPoint ( const PtrWatchPoint & watchPoint )

Adds a configured WatchPoint to the ParticipantState.

Definition at line 50 of file ParticipantState.cpp.

◆ addWriteData()

void precice::impl::ParticipantState::addWriteData	(	const mesh::PtrData &	data,
		const mesh::PtrMesh &	mesh )

Definition at line 98 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ addWriteMappingContext()

void precice::impl::ParticipantState::addWriteMappingContext ( const MappingContext & mappingContext )

Adds a configured write Mapping to the ParticipantState.

Definition at line 120 of file ParticipantState.cpp.

◆ checkDuplicatedData()

void precice::impl::ParticipantState::checkDuplicatedData	(	std::string_view	mesh,
		std::string_view	data )

private

Definition at line 445 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ checkDuplicatedUse()

void precice::impl::ParticipantState::checkDuplicatedUse ( std::string_view mesh )

private

Definition at line 437 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ configureInputMeshContext()

void precice::impl::ParticipantState::configureInputMeshContext	(	std::string_view	fromMesh,
		impl::MappingContext &	mappingContext,
		mapping::Mapping::MeshRequirement	requirement )

Configures the mesh context with connectivity requirements and adds it to the mappingcontext.

Definition at line 513 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ configureOutputMeshContext()

void precice::impl::ParticipantState::configureOutputMeshContext	(	std::string_view	toMesh,
		impl::MappingContext &	mappingContext,
		mapping::Mapping::MeshRequirement	requirement )

Configures the mesh context with connectivity requirements and adds it to the mappingcontext.

Definition at line 519 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ exportContexts()

const std::vector< io::ExportContext > & precice::impl::ParticipantState::exportContexts ( ) const

Returns all ExportContext for exporting meshes and data.

Definition at line 349 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ exportInitial()

void precice::impl::ParticipantState::exportInitial ( )

Definition at line 374 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ exportIntermediate()

void precice::impl::ParticipantState::exportIntermediate ( IntermediateExport exp )

Exports timewindows and iterations of meshes and watchpoints.

Definition at line 404 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ findMesh()

mesh::PtrMesh precice::impl::ParticipantState::findMesh ( std::string_view data ) const

Returns the mesh associated with ReadDataContext with given data name in _readDataContexts of this Participant.

Parameters

data	name of the data

Returns: mesh::PtrMesh, returns nullptr, if no read data contest for given data name was found

Definition at line 141 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ getName()

const std::string & precice::impl::ParticipantState::getName ( ) const

Definition at line 369 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ hasData()

bool precice::impl::ParticipantState::hasData	(	std::string_view	mesh,
		std::string_view	data ) const

Is the dataID know to preCICE?

Definition at line 168 of file ParticipantState.cpp.

◆ hasExports()

bool precice::impl::ParticipantState::hasExports ( ) const

Returns true, if the participant has any exports enabled.

Definition at line 399 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ hasMesh()

bool precice::impl::ParticipantState::hasMesh ( std::string_view mesh ) const

Does preCICE know a mesh with this name?

Definition at line 223 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ hasReadMappings()

bool precice::impl::ParticipantState::hasReadMappings ( ) const

Returns true, if the participant has at least one read mapping.

Definition at line 313 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ hasWriteMappings()

bool precice::impl::ParticipantState::hasWriteMappings ( ) const

Returns true, if the participant has at least one write mapping.

Definition at line 318 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ hintForMesh()

std::string precice::impl::ParticipantState::hintForMesh ( std::string_view mesh ) const

Definition at line 453 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ hintForMeshData()

std::string precice::impl::ParticipantState::hintForMeshData	(	std::string_view	mesh,
		std::string_view	data ) const

Definition at line 470 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ initializeMappingDataCache()

void precice::impl::ParticipantState::initializeMappingDataCache ( std::string_view mappingType )

Initializes the MappingDataCache in the DataContext after having computed the mappings.

Definition at line 500 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ isDataRead()

bool precice::impl::ParticipantState::isDataRead	(	std::string_view	mesh,
		std::string_view	data ) const

Is the participant allowed to read the data?

Definition at line 187 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ isDataUsed()

bool precice::impl::ParticipantState::isDataUsed	(	std::string_view	mesh,
		std::string_view	data ) const

Is the data used by this participant?

Definition at line 180 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ isDataValid()

template<typename ELEMENT_T>

bool precice::impl::ParticipantState::isDataValid	(	const std::vector< ELEMENT_T > &	data,
		const ELEMENT_T &	newElement ) const

private

Definition at line 439 of file ParticipantState.hpp.

◆ isDataWrite()

bool precice::impl::ParticipantState::isDataWrite	(	std::string_view	mesh,
		std::string_view	data ) const

Is the participant allowed to write the data?

Definition at line 192 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ isDirectAccessAllowed()

bool precice::impl::ParticipantState::isDirectAccessAllowed ( std::string_view mesh ) const

Returns whether we are allowed to access a received mesh direct which requires the config tag <receive-mesh ... direct-access="true"

Definition at line 249 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ isMeshProvided()

bool precice::impl::ParticipantState::isMeshProvided ( std::string_view mesh ) const

Is a mesh with this name provided by this participant?

Definition at line 237 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ isMeshReceived()

bool precice::impl::ParticipantState::isMeshReceived ( std::string_view mesh ) const

Is a mesh with this name received by this participant?

Definition at line 243 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ isMeshUsed()

bool precice::impl::ParticipantState::isMeshUsed ( std::string_view mesh ) const

Is a mesh with this name used by this participant?

Definition at line 228 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ meshContext() [1/2]

MeshContext & precice::impl::ParticipantState::meshContext ( std::string_view mesh )

Definition at line 206 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ meshContext() [2/2]

const MeshContext & precice::impl::ParticipantState::meshContext ( std::string_view mesh ) const

Mesh queries.

Definition at line 199 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ providedMeshContext() [1/2]

ProvidedMeshContext & precice::impl::ParticipantState::providedMeshContext ( std::string_view mesh )

Provides access to a ProvidedMeshContext given the mesh name.

Parameters

[in] mesh the name of the mesh

Precondition: The mesh must be a provided mesh (check with isMeshProvided())

Returns: a reference to the ProvidedMeshContext

Definition at line 275 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ providedMeshContext() [2/2]

const ProvidedMeshContext & precice::impl::ParticipantState::providedMeshContext ( std::string_view mesh ) const

Provides const access to a ProvidedMeshContext given the mesh name.

Parameters

[in] mesh the name of the mesh

Precondition: The mesh must be a provided mesh (check with isMeshProvided())

Returns: a const reference to the ProvidedMeshContext

Definition at line 283 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ providedMeshContexts() [1/2]

std::deque< ProvidedMeshContext > & precice::impl::ParticipantState::providedMeshContexts ( )

Provides access to all ProvidedMeshContexts.

Returns: a reference to the deque of ProvidedMeshContext

Definition at line 291 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ providedMeshContexts() [2/2]

const std::deque< ProvidedMeshContext > & precice::impl::ParticipantState::providedMeshContexts ( ) const

Provides const access to all ProvidedMeshContexts.

Returns: a const reference to the deque of ProvidedMeshContext

Definition at line 296 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ provideMesh()

void precice::impl::ParticipantState::provideMesh ( mesh::PtrMesh mesh )

Adds a mesh to be provided by the participant.

Definition at line 62 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ readDataContext() [1/2]

ReadDataContext & precice::impl::ParticipantState::readDataContext	(	std::string_view	mesh,
		std::string_view	data )

Provides access to ReadDataContext

Precondition: there exists a ReadDataContext for data

Definition at line 134 of file ParticipantState.cpp.

◆ readDataContext() [2/2]

const ReadDataContext & precice::impl::ParticipantState::readDataContext	(	std::string_view	mesh,
		std::string_view	data ) const

Provides access to ReadDataContext

Precondition: there exists a ReadDataContext for data

Definition at line 127 of file ParticipantState.cpp.

◆ readDataContexts()

auto precice::impl::ParticipantState::readDataContexts ( )

inline

Provides access to all ReadDataContext objects

Remarks: does not contain nullptr.

Definition at line 197 of file ParticipantState.hpp.

◆ readMappingContexts()

std::vector< MappingContext > & precice::impl::ParticipantState::readMappingContexts ( )

Provided access to all read MappingContext.

Definition at line 323 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ receivedMeshContext() [1/2]

ReceivedMeshContext & precice::impl::ParticipantState::receivedMeshContext ( std::string_view mesh )

Provides access to a ReceivedMeshContext given the mesh name.

Parameters

[in] mesh the name of the mesh

Returns: a reference to the ReceivedMeshContext

Precondition: the mesh is a received mesh (use isMeshReceived() to check)

Definition at line 259 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ receivedMeshContext() [2/2]

const ReceivedMeshContext & precice::impl::ParticipantState::receivedMeshContext ( std::string_view mesh ) const

Provides const access to a ReceivedMeshContext given the mesh name.

Parameters

[in] mesh the name of the mesh

Returns: a const reference to the ReceivedMeshContext

Precondition: the mesh is a received mesh (use isMeshReceived() to check)

Definition at line 267 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ receivedMeshContexts() [1/2]

std::deque< ReceivedMeshContext > & precice::impl::ParticipantState::receivedMeshContexts ( )

Provides access to all ReceivedMeshContexts.

Returns: a reference to the deque of ReceivedMeshContext

Definition at line 301 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ receivedMeshContexts() [2/2]

const std::deque< ReceivedMeshContext > & precice::impl::ParticipantState::receivedMeshContexts ( ) const

Provides const access to all ReceivedMeshContexts.

Returns: a const reference to the deque of ReceivedMeshContext

Definition at line 306 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ receiveMesh()

void precice::impl::ParticipantState::receiveMesh	(	mesh::PtrMesh	mesh,
		const std::string &	fromParticipant,
		double	safetyFactor,
		partition::ReceivedPartition::GeometricFilter	geoFilter,
		const bool	allowDirectAccess )

Adds a mesh to be received by the participant.

Definition at line 74 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ setUsePrimaryRank()

void precice::impl::ParticipantState::setUsePrimaryRank ( bool useIntraComm )

Sets weather the participant was configured with a primary tag.

Definition at line 45 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ usedMeshContexts() [1/2]

std::vector< MeshContextVariant > & precice::impl::ParticipantState::usedMeshContexts ( )

Provides unordered access to all MeshContext.used by this ParticipantState

Remarks: The sequence does not contain nullptr

Definition at line 218 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ usedMeshContexts() [2/2]

const std::vector< MeshContextVariant > & precice::impl::ParticipantState::usedMeshContexts ( ) const

Provides unordered access to all MeshContext.used by this ParticipantState

Remarks: The sequence does not contain nullptr

Definition at line 213 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ useIntraComm()

bool precice::impl::ParticipantState::useIntraComm ( ) const

Returns true, if the participant uses a primary tag.

Definition at line 364 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ watchIntegrals()

std::vector< PtrWatchIntegral > & precice::impl::ParticipantState::watchIntegrals ( )

Provided access to all WatchIntegrals.

Definition at line 359 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ watchPoints()

std::vector< PtrWatchPoint > & precice::impl::ParticipantState::watchPoints ( )

Provided access to all WatchPoints.

Definition at line 354 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ writeDataContext() [1/2]

WriteDataContext & precice::impl::ParticipantState::writeDataContext	(	std::string_view	mesh,
		std::string_view	data )

Provides access to WriteDataContext

Precondition: there exists a WriteDataContext for data

Definition at line 161 of file ParticipantState.cpp.

◆ writeDataContext() [2/2]

const WriteDataContext & precice::impl::ParticipantState::writeDataContext	(	std::string_view	mesh,
		std::string_view	data ) const

Provides access to WriteDataContext

Precondition: there exists a WriteDataContext for data

Definition at line 154 of file ParticipantState.cpp.

◆ writeDataContexts()

auto precice::impl::ParticipantState::writeDataContexts ( )

inline

Provides access to all WriteDataContext objects

Remarks: does not contain nullptr.

Definition at line 189 of file ParticipantState.hpp.

◆ writeMappingContexts()

std::vector< MappingContext > & precice::impl::ParticipantState::writeMappingContexts ( )

Provided access to all write MappingContext.

Definition at line 328 of file ParticipantState.cpp.

Here is the call graph for this function:

◆ Integration::Serial::Whitebox::TestConfigurationComsol

friend struct Integration::Serial::Whitebox::TestConfigurationComsol

friend

Definition at line 433 of file ParticipantState.hpp.

◆ Integration::Serial::Whitebox::TestConfigurationPeano

friend struct Integration::Serial::Whitebox::TestConfigurationPeano

friend

To allow white box tests.

Definition at line 432 of file ParticipantState.hpp.

Member Data Documentation

◆ _actions

std::vector<action::PtrAction> precice::impl::ParticipantState::_actions

private

Definition at line 390 of file ParticipantState.hpp.

◆ _exportContexts

std::vector<io::ExportContext> precice::impl::ParticipantState::_exportContexts

private

Export contexts to export meshes, data, and more.

Definition at line 388 of file ParticipantState.hpp.

◆ _log

logging::Logger precice::impl::ParticipantState::_log {"impl::ParticipantState"}

mutableprivate

Definition at line 379 of file ParticipantState.hpp.

◆ _meshContexts

MeshMap<MeshContext *> precice::impl::ParticipantState::_meshContexts

private

All mesh contexts involved in a simulation (for name-based lookup)

Definition at line 399 of file ParticipantState.hpp.

◆ _name

std::string precice::impl::ParticipantState::_name

private

Definition at line 381 of file ParticipantState.hpp.

◆ _providedMeshContexts

std::deque<ProvidedMeshContext> precice::impl::ParticipantState::_providedMeshContexts

private

Provided mesh contexts (owning container)

Definition at line 402 of file ParticipantState.hpp.

◆ _readDataContexts

DataMap<ReadDataContext> precice::impl::ParticipantState::_readDataContexts

private

Definition at line 418 of file ParticipantState.hpp.

◆ _readMappingContexts

std::vector<MappingContext> precice::impl::ParticipantState::_readMappingContexts

private

Read mapping contexts used by the participant.

Definition at line 408 of file ParticipantState.hpp.

◆ _receivedMeshContexts

std::deque<ReceivedMeshContext> precice::impl::ParticipantState::_receivedMeshContexts

private

Received mesh contexts (owning container)

Definition at line 405 of file ParticipantState.hpp.

◆ _usedMeshContexts

std::vector<MeshContextVariant> precice::impl::ParticipantState::_usedMeshContexts

private

Mesh contexts used by the participant.

Definition at line 414 of file ParticipantState.hpp.

◆ _useIntraComm

bool precice::impl::ParticipantState::_useIntraComm = false

private

Definition at line 420 of file ParticipantState.hpp.

◆ _watchIntegrals

std::vector<PtrWatchIntegral> precice::impl::ParticipantState::_watchIntegrals

private

Definition at line 385 of file ParticipantState.hpp.

◆ _watchPoints

std::vector<PtrWatchPoint> precice::impl::ParticipantState::_watchPoints

private

Definition at line 383 of file ParticipantState.hpp.

◆ _writeDataContexts

DataMap<WriteDataContext> precice::impl::ParticipantState::_writeDataContexts

private

Definition at line 416 of file ParticipantState.hpp.

◆ _writeMappingContexts

std::vector<MappingContext> precice::impl::ParticipantState::_writeMappingContexts

private

Write mapping contexts used by the participant.

Definition at line 411 of file ParticipantState.hpp.

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

src/precice/impl/ParticipantState.hpp
src/precice/impl/ParticipantState.cpp

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ DataMap

◆ MeshMap

Member Enumeration Documentation

◆ MappingConstants

Constructor & Destructor Documentation

◆ ParticipantState()

Member Function Documentation

◆ actions() [1/2]

◆ actions() [2/2]

◆ addAction()

◆ addExportContext()

◆ addReadData()

◆ addReadMappingContext()

◆ addWatchIntegral()

◆ addWatchPoint()

◆ addWriteData()

◆ addWriteMappingContext()

◆ checkDuplicatedData()

◆ checkDuplicatedUse()

◆ configureInputMeshContext()

◆ configureOutputMeshContext()

◆ exportContexts()

◆ exportInitial()

◆ exportIntermediate()

◆ findMesh()

◆ getName()

◆ hasData()

◆ hasExports()

◆ hasMesh()

◆ hasReadMappings()

◆ hasWriteMappings()

◆ hintForMesh()

◆ hintForMeshData()

◆ initializeMappingDataCache()

◆ isDataRead()

◆ isDataUsed()

◆ isDataValid()

◆ isDataWrite()

◆ isDirectAccessAllowed()

◆ isMeshProvided()

◆ isMeshReceived()

◆ isMeshUsed()

◆ meshContext() [1/2]

◆ meshContext() [2/2]

◆ providedMeshContext() [1/2]

◆ providedMeshContext() [2/2]

◆ providedMeshContexts() [1/2]

◆ providedMeshContexts() [2/2]

◆ provideMesh()

◆ readDataContext() [1/2]

◆ readDataContext() [2/2]

◆ readDataContexts()

◆ readMappingContexts()

◆ receivedMeshContext() [1/2]

◆ receivedMeshContext() [2/2]

◆ receivedMeshContexts() [1/2]

◆ receivedMeshContexts() [2/2]

◆ receiveMesh()

◆ setUsePrimaryRank()

◆ usedMeshContexts() [1/2]

◆ usedMeshContexts() [2/2]

◆ useIntraComm()

◆ watchIntegrals()

◆ watchPoints()

◆ writeDataContext() [1/2]

◆ writeDataContext() [2/2]

◆ writeDataContexts()

◆ writeMappingContexts()

Friends And Related Symbol Documentation

◆ Integration::Serial::Whitebox::TestConfigurationComsol

◆ Integration::Serial::Whitebox::TestConfigurationPeano