Particle class for usage with Monte Carlo radiative transfer. More...

#include <CD_Photon.H>

Inheritance diagram for Photon:

[legend]

Collaboration diagram for Photon:

[legend]

Public Member Functions
	Photon ()
	Default constructor. Must subsequently set all parameters.

	Photon (const RealVect &a_position, const RealVect &a_velocity, const Real &a_kappa, const Real a_weight=1.0)
	Full constructor.

virtual	~Photon ()
	Destructor (does nothing)

void	define (const RealVect &a_position, const RealVect &a_velocity, const Real &a_kappa, const Real a_weight=1.0)
	Define function. Sets all parameters.

Real &	weight ()
	Get photon weight.

const Real &	weight () const
	Get particle weight.

Real &	kappa ()
	Get photon absorption length.

const Real &	kappa () const
	Get mean absorption length.

RealVect &	velocity ()
	Get photon velocity.

const RealVect &	velocity () const
	Get photon velocity.

Public Member Functions inherited from GenericParticle< 2, 1 >
	GenericParticle ()
	Default constructor – initializes everything to zero.

	GenericParticle (const GenericParticle< M, N > &a_other)
	Copy constructor. Copies all fields.

virtual	~GenericParticle ()
	Destructor (deallocates runtime memory storage)

const int32_t &	particleID () const noexcept
	Get the particle ID.

int32_t &	particleID () noexcept
	Get the particle ID.

const int32_t &	rankID () const noexcept
	Get the MPI rank ID.

int32_t &	rankID () noexcept
	Get the MPI rank ID.

RealVect &	position ()
	Get the particle position.

const RealVect &	position () const
	Get the particle position.

const std::array< Real, M > &	getReals () const noexcept
	Get the M scalars.

std::array< Real, M > &	getReals () noexcept
	Get the M scalars.

const std::array< RealVect, N > &	getVects () const noexcept
	Get the N vectors.

std::array< RealVect, N > &	getVects () noexcept
	Get the N vectors.

Real &	real ()
	Get one of the scalars.

const Real &	real () const
	Get one of the scalars.

RealVect &	vect ()
	Get one of the RealVects.

const RealVect &	vect () const
	Get one of the RealVects.

bool	operator== (const GenericParticle< M, N > &a_p) const
	Comparison operator with other particle.

bool	operator!= (const GenericParticle< M, N > &a_p) const
	Comparison operator with other particle.

bool	operator< (const GenericParticle< M, N > &a_other) const noexcept
	Particle comparison operator. Returns lexicographical ordering.

virtual int	size () const
	Returns the size, in number of bytes, of a flat representation of the data in this object.

virtual void	linearOut (void *a_buffer) const
	Write a linear binary representation of the internal data. Assumes that sufficient memory for the buffer has already been allocated by the caller.

virtual void	linearIn (const void *a_buffer)
	Read a linear binary representation of the internal data. Assumes that the buffer has the correct data.

virtual int	H5size () const
	Function that is used when writing particles to HDF5.

virtual void	H5linearOut (void *a_buffer) const
	Linearize the Real components onto a buffer workable by HDF5.

virtual void	H5linearIn (const void *a_buffer)
	Delinearize the buffer onto the real components in the particle class.

Additional Inherited Members
Protected Attributes inherited from GenericParticle< 2, 1 >
int32_t	m_particleID
	Particle ID.

int32_t	m_rankID
	MPI rank owning this particle.

RealVect	m_position
	Particle position.

std::array< Real, M >	m_scalars
	Scalar storage array.

std::array< RealVect, N >	m_vectors
	vector storage array

Detailed Description

Particle class for usage with Monte Carlo radiative transfer.

Constructor & Destructor Documentation

◆ Photon()

Photon::Photon	(	const RealVect &	a_position,
		const RealVect &	a_velocity,
		const Real &	a_kappa,
		const Real	a_weight = `1.0`
	)

inline

Full constructor.

Parameters

[in]	a_position	Photon position
[in]	a_velocity	Photon velocity
[in]	a_kappa	Mean absorption length
[in]	a_weight	Particle weight. a_weight=1 implies a physical photon.

Member Function Documentation

◆ define()

void Photon::define	(	const RealVect &	a_position,
		const RealVect &	a_velocity,
		const Real &	a_kappa,
		const Real	a_weight = `1.0`
	)

inline

Define function. Sets all parameters.

Parameters

[in]	a_position	Photon position
[in]	a_velocity	Photon velocity
[in]	a_kappa	Mean absorption length
[in]	a_weight	Particle weight. a_weight=1 implies a physical photon.

◆ kappa() [1/2]

Real & Photon::kappa ( )

inline

Get photon absorption length.

Returns: Return value

◆ kappa() [2/2]

const Real & Photon::kappa ( ) const

inline

Get mean absorption length.

Returns: Return value

◆ velocity() [1/2]

RealVect & Photon::velocity ( )

inline

Get photon velocity.

Returns: Return value

◆ velocity() [2/2]

const RealVect & Photon::velocity ( ) const

inline

Get photon velocity.

Returns: Return value

◆ weight() [1/2]

Real & Photon::weight ( )

inline

Get photon weight.

Returns: Return value

◆ weight() [2/2]

const Real & Photon::weight ( ) const

inline

Get particle weight.

Returns: Return value

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

Source/RadiativeTransfer/CD_Photon.H
Source/RadiativeTransfer/CD_PhotonImplem.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Photon()

Member Function Documentation

◆ define()

◆ kappa() [1/2]

◆ kappa() [2/2]

◆ velocity() [1/2]

◆ velocity() [2/2]

◆ weight() [1/2]

◆ weight() [2/2]