Class implements the radioactive decay chain. More...

#include <radioactive_decay.hh>

Inheritance diagram for RadioactiveDecay:

Collaboration diagram for RadioactiveDecay:

[legend]

Public Types
typedef ReactionTerm	FactoryBaseType

Public Types inherited from ReactionTerm
typedef std::vector< std::shared_ptr< FieldFE< 3, FieldValue< 3 >::Scalar > > >	FieldFEScalarVec

Public Member Functions
	RadioactiveDecay (Mesh &mesh, Input::Record in_rec)
	Constructor. More...

	~RadioactiveDecay (void)
	Destructor. More...

Public Member Functions inherited from FirstOrderReactionBase
	FirstOrderReactionBase (Mesh &init_mesh, Input::Record in_rec)
	Constructor. More...

	~FirstOrderReactionBase (void)
	Destructor. More...

void	initialize () override
	Prepares the object to usage. More...

void	zero_time_step () override
	Moves the model to zero time. More...

void	update_solution (void) override
	Updates the solution. More...

Public Member Functions inherited from ReactionTerm
	TYPEDEF_ERR_INFO (EI_Substance, std::string)

	TYPEDEF_ERR_INFO (EI_Model, std::string)

	DECLARE_INPUT_EXCEPTION (ExcUnknownSubstance,<< "Unknown substance name: "<< EI_Substance::qval)

	DECLARE_INPUT_EXCEPTION (ExcWrongDescendantModel,<< "Impossible descendant model: "<< EI_Model::qval)

	ReactionTerm (Mesh &init_mesh, Input::Record in_rec)

	~ReactionTerm (void)
	Destructor. More...

ReactionTerm &	substances (SubstanceList &substances)
	Sets the names of substances considered in transport. More...

ReactionTerm &	output_stream (std::shared_ptr< OutputTime > ostream)
	Sets the output stream which is given from transport class. More...

ReactionTerm &	concentration_fields (FieldFEScalarVec &conc_mobile)

virtual void	output_data (void) override
	Output method. More...

void	choose_next_time (void) override
	Disable changes in TimeGovernor by empty method. More...

Public Member Functions inherited from EquationBase
	EquationBase ()

	EquationBase (Mesh &mesh, const Input::Record in_rec)

virtual	~EquationBase ()

virtual void	set_time_upper_constraint (double dt, std::string message)

virtual void	set_time_lower_constraint (double dt, std::string message)

TimeGovernor &	time ()

virtual void	set_time_governor (TimeGovernor &time)

double	planned_time ()

virtual double	solved_time ()

Mesh &	mesh ()

std::shared_ptr< Balance >	balance () const

TimeMark::Type	mark_type ()

FieldSet &	eq_fieldset ()

std::shared_ptr< FieldSet >	eq_fieldset_ptr ()

void	init_user_fields (Input::Array user_fields, FieldSet &output_fields)

Static Public Member Functions
static const Input::Type::Record &	get_input_type ()
	Input record for class RadioactiveDecay. More...

static const Input::Type::Record &	get_input_type_single_decay ()
	Input record which defines particular decay step. More...

static const Input::Type::Record &	get_input_type_product ()
	Input record for a product of a radioactive decay. More...

Static Public Member Functions inherited from ReactionTerm
static Input::Type::Abstract &	it_abstract_term ()

static Input::Type::Abstract &	it_abstract_mobile_term ()

static Input::Type::Abstract &	it_abstract_immobile_term ()

static Input::Type::Abstract &	it_abstract_reaction ()

Static Public Member Functions inherited from EquationBase
static Input::Type::Record &	record_template ()
	Template Record with common keys for derived equations. More...

static Input::Type::Record &	user_fields_template (std::string equation_name)
	Template Record with common key user_fields for derived equations. More...

Protected Member Functions
void	initialize_from_input () override
	Initializes private members of sorption from the input record. More...

void	assemble_ode_matrix (void) override
	Implements the assembly of the system matrix of the ODEs. More...

Protected Member Functions inherited from FirstOrderReactionBase
virtual void	compute_reaction (const DHCellAccessor &dh_cell) override
	Computes the reaction on a specified element. More...

unsigned int	find_subst_name (const std::string &name)

Protected Member Functions inherited from ReactionTerm

Protected Attributes
std::vector< double >	half_lives_
	Half-lives of the substances. More...

Protected Attributes inherited from FirstOrderReactionBase
std::vector< std::vector< unsigned int > >	substance_ids_

std::vector< std::vector< double > >	bifurcation_

unsigned int	n_substances_
	Number of all transported substances. It is the dimension of the reaction matrix. More...

arma::mat	reaction_matrix_
	Reaction matrix. More...

arma::vec	prev_conc_
	Column vector storing previous concetrations on an element. More...

arma::mat	molar_matrix_
	Diagonal matrix with molar masses of substances. More...

arma::mat	molar_mat_inverse_
	Inverse of `molar_matrix_`. More...

std::shared_ptr< LinearODESolver >	linear_ode_solver_

Protected Attributes inherited from ReactionTerm
std::shared_ptr< OutputTime >	output_stream_
	Pointer to a transport output stream. More...

std::shared_ptr< EqFields >	eq_fields_base_
	Equation data - all fields needs in assembly class. More...

std::shared_ptr< EqData >	eq_data_base_
	Equation data - all data needs in assembly class. More...

Protected Attributes inherited from EquationBase
bool	equation_empty_
	flag is true if only default constructor was called More...

Mesh *	mesh_

TimeGovernor *	time_

Input::Record	input_record_

std::shared_ptr< FieldSet >	eq_fieldset_

std::shared_ptr< Balance >	balance_
	object for calculation and writing the mass balance to file. More...

Static Private Attributes
static const int	registrar
	Registrar of class to factory. More...

Detailed Description

Class implements the radioactive decay chain.

This class implements the user interface for radioactive decay chain and prepares the reaction matrix, The decay behaves like the linear reaction thus everything else is inherited from the FirstOrderReactionBase class.

TODO: fix the mass balance - we do not take in account the emitted particles.

Definition at line 43 of file radioactive_decay.hh.

Member Typedef Documentation

◆ FactoryBaseType

typedef ReactionTerm RadioactiveDecay::FactoryBaseType

Definition at line 46 of file radioactive_decay.hh.

Constructor & Destructor Documentation

◆ RadioactiveDecay()

RadioactiveDecay::RadioactiveDecay	(	Mesh &	mesh,
		Input::Record	in_rec
	)

Constructor.

Definition at line 78 of file radioactive_decay.cc.

◆ ~RadioactiveDecay()

RadioactiveDecay::~RadioactiveDecay ( void )

Destructor.

Definition at line 83 of file radioactive_decay.cc.

Member Function Documentation

◆ assemble_ode_matrix()

void RadioactiveDecay::assemble_ode_matrix ( void )

overrideprotectedvirtual

Implements the assembly of the system matrix of the ODEs.

Implements FirstOrderReactionBase.

Definition at line 149 of file radioactive_decay.cc.

◆ get_input_type()

const Record & RadioactiveDecay::get_input_type ( )

static

Input record for class RadioactiveDecay.

Definition at line 61 of file radioactive_decay.cc.

◆ get_input_type_product()

const Record & RadioactiveDecay::get_input_type_product ( )

static

Input record for a product of a radioactive decay.

Definition at line 35 of file radioactive_decay.cc.

Here is the caller graph for this function:

◆ get_input_type_single_decay()

const Record & RadioactiveDecay::get_input_type_single_decay ( )

static

Input record which defines particular decay step.

Definition at line 50 of file radioactive_decay.cc.

Here is the caller graph for this function:

◆ initialize_from_input()

void RadioactiveDecay::initialize_from_input ( )

overrideprotectedvirtual

Initializes private members of sorption from the input record.

Implements FirstOrderReactionBase.

Definition at line 88 of file radioactive_decay.cc.

Member Data Documentation

◆ half_lives_

std::vector<double> RadioactiveDecay::half_lives_

protected

Half-lives of the substances.

Definition at line 66 of file radioactive_decay.hh.

◆ registrar

const int RadioactiveDecay::registrar

staticprivate

Initial value:

=
        Input::register_class< RadioactiveDecay, Mesh &, Input::Record >("RadioactiveDecay") +
        RadioactiveDecay::get_input_type().size()

Registrar of class to factory.

Definition at line 70 of file radioactive_decay.hh.

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

/home/runner/work/flow123d/flow123d/src/reaction/radioactive_decay.hh
/home/runner/work/flow123d/flow123d/src/reaction/radioactive_decay.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ FactoryBaseType

Constructor & Destructor Documentation

◆ RadioactiveDecay()

◆ ~RadioactiveDecay()

Member Function Documentation

◆ assemble_ode_matrix()

◆ get_input_type()

◆ get_input_type_product()

◆ get_input_type_single_decay()

◆ initialize_from_input()

Member Data Documentation

◆ half_lives_

◆ registrar