radioactive_decay.hh

Go to the documentation of this file.

/*!
 *
 * Copyright (C) 2015 Technical University of Liberec.  All rights reserved.
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License version 3 as published by the
 * Free Software Foundation. (http://www.gnu.org/licenses/gpl-3.0.en.html)
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 *
 * 
 * @file    radioactive_decay.hh
 * @brief   
 */

#ifndef RADIOACTIVE_DECAY_H_
#define RADIOACTIVE_DECAY_H_

#include <vector>

#include "reaction/reaction_term.hh"              // for ReactionTerm
#include "reaction/first_order_reaction_base.hh"

class Mesh;
namespace Input {
    class Record;
    namespace Type {
        class Record;
    }
}


/** @brief 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 @p FirstOrderReactionBase class.
 * 
 * TODO: fix the mass balance - we do not take in account the emitted particles.
 */
class RadioactiveDecay: public FirstOrderReactionBase
{
public:
    typedef ReactionTerm FactoryBaseType;

    static const Input::Type::Record & get_input_type();              ///< Input record for class RadioactiveDecay.
    static const Input::Type::Record & get_input_type_single_decay(); ///< Input record which defines particular decay step.
    static const Input::Type::Record & get_input_type_product();      ///< Input record for a product of a radioactive decay.
    
    /// Constructor.
    RadioactiveDecay(Mesh &mesh, Input::Record in_rec);

    /// Destructor.
    ~RadioactiveDecay(void);


protected:
    /// Initializes private members of sorption from the input record.
    void initialize_from_input() override;
    
    /// Implements the assembly of the system matrix of the ODEs.
    void assemble_ode_matrix(void) override;
    
    std::vector<double> half_lives_;    ///< Half-lives of the substances.

private:
    /// Registrar of class to factory
    static const int registrar;
};

#endif // RADIOACTIVE_DECAY_H_