Public Member Functions | List of all members
beluga::detail::make_from_state_fn< Particle, State > Struct Template Reference

Function object type to create a particle from a given state. More...

#include <particle_traits.hpp>

Public Member Functions

constexpr auto operator() (State value) const
 Returns a new particle from the given state. More...
 

Detailed Description

template<class Particle, class State = state_t<Particle>>
struct beluga::detail::make_from_state_fn< Particle, State >

Function object type to create a particle from a given state.

Definition at line 84 of file particle_traits.hpp.

Member Function Documentation

◆ operator()()

template<class Particle , class State = state_t<Particle>>
constexpr auto beluga::detail::make_from_state_fn< Particle, State >::operator() ( State  value) const
inlineconstexpr

Returns a new particle from the given state.

Parameters
valueThe state to make the particle from.
Returns
The new particle, created from the given state.

The new particle will have a weight equal to 1.

Definition at line 92 of file particle_traits.hpp.


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


beluga
Author(s):
autogenerated on Tue Jul 16 2024 02:59:54