Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
trento::Proton Class Reference

Trivial nucleus with a single nucleon. More...

#include <JETSCAPE/blob/main/external_packages/trento/src/nucleus.h>

+ Inheritance diagram for trento::Proton:
+ Collaboration diagram for trento::Proton:

Public Member Functions

 Proton ()
 Default constructor.
 
virtual double radius () const override
 The radius of a proton is trivially zero.
 
- Public Member Functions inherited from trento::Nucleus
virtual ~Nucleus ()=default
 Default virtual destructor for abstract base class.
 
void sample_nucleons (double offset)
 
size_type size () const noexcept
 
iterator begin () noexcept
 
iterator end () noexcept
 
const_iterator begin () const noexcept
 
const_iterator end () const noexcept
 
const_iterator cbegin () const noexcept
 
const_iterator cend () const noexcept
 

Private Member Functions

virtual void sample_nucleons_impl () override
 The proton trivially places its nucleon at the origin.
 

Additional Inherited Members

- Public Types inherited from trento::Nucleus
using size_type = std::vector< Nucleon >::size_type
 
using iterator = std::vector< Nucleon >::iterator
 
using const_iterator = std::vector< Nucleon >::const_iterator
 
- Static Public Member Functions inherited from trento::Nucleus
static NucleusPtr create (const std::string &species, double nucleon_width, double nucleon_dmin=0)
 
- Protected Member Functions inherited from trento::Nucleus
 Nucleus (std::size_t A)
 
void set_nucleon_position (iterator nucleon, double x, double y, double z)
 

Detailed Description

Trivial nucleus with a single nucleon.

Definition at line 138 of file nucleus.h.

View newest version in sPHENIX GitHub at line 138 of file nucleus.h

Constructor & Destructor Documentation

trento::Proton::Proton ( )

Default constructor.

Definition at line 102 of file nucleus.cxx.

View newest version in sPHENIX GitHub at line 102 of file nucleus.cxx

Member Function Documentation

double trento::Proton::radius ( ) const
overridevirtual

The radius of a proton is trivially zero.

Always zero.

Implements trento::Nucleus.

Definition at line 105 of file nucleus.cxx.

View newest version in sPHENIX GitHub at line 105 of file nucleus.cxx

void trento::Proton::sample_nucleons_impl ( )
overrideprivatevirtual

The proton trivially places its nucleon at the origin.

Always place the nucleon at the origin.

Implements trento::Nucleus.

Definition at line 110 of file nucleus.cxx.

View newest version in sPHENIX GitHub at line 110 of file nucleus.cxx

References trento::Nucleus::begin(), and trento::Nucleus::set_nucleon_position().

+ Here is the call graph for this function:


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