minimc 0.5.1
Loading...
Searching...
No Matches
ContinuousCapture Class Reference

Contains data required to perform a capture interaction. More...

#include <ContinuousReaction.hpp>

Inheritance diagram for ContinuousCapture:
Collaboration diagram for ContinuousCapture:

Public Member Functions

 ContinuousCapture (const pugi::xml_node &capture_node)
 Constructs a ContinuousCapture from a capture node of an XML document.
 
void Interact (Particle &p) const noexcept override
 Captures the Particle, ending its history. More...
 
- Public Member Functions inherited from ContinuousReaction
 ContinuousReaction (const pugi::xml_node &reaction_node)
 Constructs ContinuousReaction from a reaction node of an XML document.
 
virtual ~ContinuousReaction () noexcept
 Virtual destructor (C++ Core Guidelines C.127)
 
virtual bool ModifiesTotal (const Particle &) const noexcept
 Returns true if the reaction's cross section will change the total cross section. More...
 
virtual MicroscopicCrossSection GetMajorant (const Particle &p) const noexcept
 Returns the largest cross section that may be found within the current Cell. More...
 
virtual MicroscopicCrossSection GetCrossSection (const Particle &p) const noexcept
 Returns temperature-adjusted cross section for the reaction. More...
 
virtual void Interact (Particle &p) const noexcept=0
 Interact with a Particle, updating its state. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ContinuousReaction
static std::unique_ptr< const ContinuousReactionCreate (const pugi::xml_node &reaction_node)
 Factory method to create a new ContinuousReaction from an XML document.
 
- Protected Attributes inherited from ContinuousReaction
const ContinuousEvaluation evaluation
 Cross section data associated with reaction.
 

Detailed Description

Contains data required to perform a capture interaction.

Member Function Documentation

◆ Interact()

void ContinuousCapture::Interact ( Particle p) const
overridevirtualnoexcept

Captures the Particle, ending its history.

Implements ContinuousReaction.


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