Represents a ParticipantState in a test. More...

#include <TestContext.hpp>

Collaboration diagram for precice::testing::ParticipantState:

Public Member Functions
	ParticipantState (std::string n)
	Constructs a serial participant with a given name.

ParticipantState &	operator() (Ranks rsize)

ParticipantState &	setupIntraComm ()

Public Attributes
std::string	name
	the name of the participant

int	size = 1
	the amount of ranks this participant runs on

bool	initIntraComm = false
	whether to initialize an intra-participant communication for this participant

Detailed Description

Represents a ParticipantState in a test.

Definition at line 46 of file TestContext.hpp.

Constructor & Destructor Documentation

◆ ParticipantState()

precice::testing::ParticipantState::ParticipantState ( std::string n )

inlineexplicit

Constructs a serial participant with a given name.

Definition at line 57 of file TestContext.hpp.

Member Function Documentation

◆ operator()()

ParticipantState & precice::testing::ParticipantState::operator() ( Ranks rsize )

inline

Injects the amount of ranks this participant should run on.

This call operator allows to write "Fluid"_on(3_ranks)

Parameters

[in] rsize the amount of Ranks to run on.

Returns: A reference to the ParticipantState allowing for chaining.

Definition at line 68 of file TestContext.hpp.

◆ setupIntraComm()

ParticipantState & precice::testing::ParticipantState::setupIntraComm ( )

inline

Marks that this ParticipantState should initialize an intra-participant connection.

Returns: A reference to the ParticipantState allowing for chaining.

Definition at line 78 of file TestContext.hpp.

Member Data Documentation

◆ initIntraComm

bool precice::testing::ParticipantState::initIntraComm = false

whether to initialize an intra-participant communication for this participant

Definition at line 54 of file TestContext.hpp.

◆ name

std::string precice::testing::ParticipantState::name

the name of the participant

Definition at line 48 of file TestContext.hpp.

◆ size

int precice::testing::ParticipantState::size = 1

the amount of ranks this participant runs on

Definition at line 51 of file TestContext.hpp.

The documentation for this struct was generated from the following file:

src/testing/TestContext.hpp

Public Member Functions

Public Attributes