SNOWPACK 20240621.6fbafe7
MainPage.h
Go to the documentation of this file.
1/***********************************************************************************/
2/* Copyright 2009-2010 WSL Institute for Snow and Avalanche Research SLF-DAVOS */
3/***********************************************************************************/
4/* This file is part of SNOWPACK.
5 SNOWPACK is free software: you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
9
10 SNOWPACK is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public License
16 along with SNOWPACK. If not, see <http://www.gnu.org/licenses/>.
17*/
18#ifndef MAINPAGE_H
19#define MAINPAGE_H
20
21//groups);
677 * @endcode
678 *
679 * @section function_pointer Function pointer typedef
680 * All these methods sharing the same prototype, a generic function pointer type can be defined in the Stability class:
681 * @code
682 * typedef double (*StabMemFn)(const ElementData&, const double&);
683 * @endcode
684 *
685 * @section model_map Model map
686 * Once an alternative implementation has been written (and properly declared in the "StabilityAlgorithms.h" header %file), it must be "registered" in the model map. In our exmaple, this map
687 * is defined in the "Stability.h" header %file:
688 * @code
689 * static std::map<std::string, StabMemFn> mapHandHardness;
690 * @endcode
691 * and statically filled in the initStaticData() method as following:
692 * @code
693 * const bool Stability::__init = Stability::initStaticData();
694 * bool Stability::initStaticData() {
695 * mapHandHardness["MONTI"] = &StabilityAlgorithms::setHandHardnessMONTI;
696 * mapHandHardness["BELLAIRE"] = &StabilityAlgorithms::setHandHardnessBELLAIRE;
697 * mapHandHardness["ASARC"] = &StabilityAlgorithms::setHandHardnessASARC;
698 * return true;
699 * }
700 * @endcode
701 * This way of fillinf the map ensures that it will be initialized only once and for all, making it consistent and efficient.
702 *
703 * @section model_user_choice User model configuration
704 * The user selection of model must be connected with the proper model implementation. The user selects the model he wants through a key in his
705 * configuration file. We need to read this key and activate the proper implementation, knowing that the proper key <-> implementation matching is done
706 * through the map:
707 * @code
708 * cfg.getValue("HARDNESS_PARAMETERIZATION", "SnowpackAdvanced", hardness_parameterization);
709 * map<string, StabMemFn>::const_iterator it1 = mapHandHardness.find(hardness_parameterization);
710 * if (it1 == mapHandHardness.end()) throw InvalidArgumentException("Unknown hardness parameterization: "+hardness_parameterization, AT);
711 * @endcode
712 * This means that in the section "SnowpackAdvanced" of his ini file, the key "HARDNESS_PARAMETERIZATION" must contain one of the strings given in the mapHandHardness
713 * above (ie. either "DEFAULT" or "MONTI" or "ASARC").
714 *
715 * @section calling_model Model call
716 * Finally, the process model has to be called where needed, so each time the hand hardness has to be computed, the call becomes:
717 * @code
718 * hardness = (mapHandHardness[hardness_parameterization]))(EMS[e], hoar_density_buried);
719 * @endcode
720 *
721 */
722
723#endif
724
725
726
727
728
729
730
double(* StabMemFn)(const ElementData &, const double &)
Definition: Stability.h:31
ELEMENT DATA used as a pointer in the SnowStation structure NOTE on M below: this is the mass of an e...
Definition: DataClasses.h:285
This class contains the stability routines for the snowpack model. Stability is found for each LAYER ...
Definition: Stability.h:49