precice::testing::TestSetup Struct Reference

Contains the setup description of a test including participants and requirements. More...

#include <TestContext.hpp>

Collaboration diagram for precice::testing::TestSetup:

Public Member Functions
template<class... T>
	TestSetup (T... args)
int	totalRanks () const
	total amount of ranks required by this setup
Option Handling
void	handleOption (ParticipantState participants)
void	handleOption (Ranks ranks)
void	handleOption (testing::Require requirement)

Public Attributes
bool	petsc = false
	whether to initialize PETSc
bool	events = false
	whether to initialize events
bool	ginkgo = false
	whether to initialize Ginkgo (the device)
std::vector< ParticipantState >	participants
	All known participants.

Detailed Description

Contains the setup description of a test including participants and requirements.

Definition at line 109 of file TestContext.hpp.

Constructor & Destructor Documentation

TestSetup()

template<class... T>

precice::testing::TestSetup::TestSetup ( T... args )

inline

Create a context representing an unnamed Participant running on a given count of Ranks and some requirements

Note

You need to construct a Participant if you require initializing an intra-participant connection "Serial"_on(3_ranks).setupIntraComm()

See also

Require

Definition at line 119 of file TestContext.hpp.

Here is the call graph for this function:

Member Function Documentation

handleOption() [1/3]

void precice::testing::TestSetup::handleOption

(

ParticipantState

participants

)

Definition at line 56 of file TestContext.cpp.

handleOption() [2/3]

void precice::testing::TestSetup::handleOption

(

Ranks

ranks

)

Definition at line 61 of file TestContext.cpp.

handleOption() [3/3]

void precice::testing::TestSetup::handleOption

(

testing::Require

requirement

)

Definition at line 36 of file TestContext.cpp.

Here is the call graph for this function:

totalRanks()

int precice::testing::TestSetup::totalRanks

(

)

const

total amount of ranks required by this setup

Definition at line 66 of file TestContext.cpp.

Here is the call graph for this function:

Member Data Documentation

events

bool precice::testing::TestSetup::events = false

whether to initialize events

Definition at line 138 of file TestContext.hpp.

ginkgo

bool precice::testing::TestSetup::ginkgo = false

whether to initialize Ginkgo (the device)

Definition at line 141 of file TestContext.hpp.

participants

std::vector<ParticipantState> precice::testing::TestSetup::participants

All known participants.

Definition at line 144 of file TestContext.hpp.

petsc

bool precice::testing::TestSetup::petsc = false

whether to initialize PETSc

Definition at line 135 of file TestContext.hpp.

---

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

• src/testing/TestContext.hpp
• src/testing/TestContext.cpp