Local synchronous action for retrieving a pointer to the NodeLock with tag LockTag on the component. More...

#include <GetLockPointer.hpp>

Public Types
using	return_type = Parallel::NodeLock *

Static Public Member Functions
template<typename ParallelComponent , typename DbTagList >
static return_type	apply (db::DataBox< DbTagList > &box, const gsl::not_null< Parallel::NodeLock * > node_lock)

Detailed Description

template<typename LockTag>
struct observers::Actions::GetLockPointer< LockTag >

Local synchronous action for retrieving a pointer to the NodeLock with tag LockTag on the component.

Warning: The retrieved pointer to a lock must only be treated as 'good' during the execution of the action from which this synchronous action is called. This is because we can only trust that charm will not migrate the component on which the action is running until after the action has completed, and it will not migrate the Nodegroup to which the lock points until a checkpoint.

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

Public Types