InitMessageOp Struct Reference

SPADES API: spades::models::Phold::InitMessageOp Struct Reference
SPADES API
spades::models::Phold::InitMessageOp Struct Reference

A struct that defines an operator for initializing entities. More...

#include <Phold.H>

Public Member Functions

template<class MParrs >
AMREX_GPU_DEVICE void operator() (const MParrs &msg_parrs, const int n, amrex::RandomEngine const &engine) const
 Callable operator to initialize an message.
 

Public Attributes

amrex::Real m_lookahead {1.0}
 Lookahead value (optional user input)
 
int m_messages_per_lp {1}
 Initial messages per LP.
 
amrex::Real m_lambda {1.0}
 

Detailed Description

A struct that defines an operator for initializing entities.

Member Function Documentation

◆ operator()()

template<class MParrs >
AMREX_GPU_DEVICE void spades::models::Phold::InitMessageOp::operator() ( const MParrs & msg_parrs,
const int n,
amrex::RandomEngine const & engine ) const
inline

Callable operator to initialize an message.

Template Parameters
MParrstype of the message particle array
Parameters
msg_parrsmessage particle array
nindex of the particle
enginerandom engine
196 {
197 const amrex::Real ts =
199 msg_parrs.m_idata[particles::CommonIntData::type_id][n] =
201 msg_parrs.m_rdata[particles::CommonRealData::timestamp][n] = ts;
202 msg_parrs.m_rdata[particles::MessageRealData::creation_time][n] =
203 0.0;
204 }
amrex::Real random_exponential(const amrex::Real lambda)
Exponential distribution.
Definition Utilities.cpp:4
amrex::Real m_lookahead
Lookahead value (optional user input)
Definition Phold.H:207
amrex::Real m_lambda
Definition Phold.H:215
@ type_id
Definition ParticleData.H:18
@ timestamp
Definition ParticleData.H:12
@ creation_time
Definition MessageData.H:13
static constexpr int MESSAGE
Message.
Definition MessageData.H:36
Here is the call graph for this function:

Member Data Documentation

◆ m_lambda

amrex::Real spades::models::Phold::InitMessageOp::m_lambda {1.0}

Width of exponential distribution (optional user input) smaller values of lambda = larger variance in random values larger values of lambda = smaller variance in random values

215{1.0};

◆ m_lookahead

amrex::Real spades::models::Phold::InitMessageOp::m_lookahead {1.0}

Lookahead value (optional user input)

207{1.0};

◆ m_messages_per_lp

int spades::models::Phold::InitMessageOp::m_messages_per_lp {1}

Initial messages per LP.

210{1};

The documentation for this struct was generated from the following file:
  • /home/runner/work/spades/spades/Source/Models/Phold.H