Browse files

bib.hpp upsted

  • Loading branch information...
1 parent bdb56af commit 5f700a32274c66b77fb405ccbef8959697fcd503 slayoo committed Jun 6, 2012
View
2 doc/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NUMBER =
# for a project that appears at the top of each page and should give viewer
# a quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF = "a modern C++ implementation of a nonoscillatory forward in time solver for systems of generalised transport equations with emphasis on cloud modelling applications"
+PROJECT_BRIEF = "a modern C++ implementation of a generalised transport equations solver with emphasis on cloud modelling applications"
# With the PROJECT_LOGO tag one can specify an logo or icon that is
# included in the documentation. The maximum height of the logo should not
View
3 src/adv_mpdata.hpp
@@ -177,8 +177,7 @@ class adv_mpdata : public adv_upstream<real_t>
/// \psi^{*}_{i+1,j+1}+\psi^{*}_{i,j+1}+\psi^{*}_{i+1,j-1}+\psi^{*}_{i,j-1}
/// }
/// \f$
- /// eq. (13-14) in Smolarkiewicz 1984 (J. Comp. Phys.,54,352-362) \n
-
+ /// eq. (13-14) in @copydetail Smolarkiewicz_1984 (J. Comp. Phys.,54,352-362) \n
public:
template <class indices_t>
void mpdata_U(
View
44 src/bib.hpp
@@ -8,17 +8,49 @@
*/
/// @brief
+/// A comparison of numerical solutions of the advective equation.
+/// J. Atmos. Sci., 31, 1500-1506.
+/// @details
+/// [Anderson and Fattahi 1974]: http://dx.doi.org/10.1175/1520-0469(1974)031<1500:ACONSO>2.0.CO;2
+/// [Anderson and Fattahi 1974][]
+typedef void Anderson_and_Fattahi_1974;
+
+/// @brief
+/// Terminal Velocities of Droplets and Crystals: Power Laws with Continuous Parameters over the Size Spectrum.
+/// J. Atmos. Sci., 59, 1872-1884.
+/// @details
/// [Khvorostyanow and Curry 2002]: http://dx.doi.org/10.1175/1520-0469(2002)059%3C1872:TVODAC%3E2.0.CO;2
/// [Khvorostyanow and Curry 2002][]
-/// @details
-/// Terminal Velocities of Droplets and Crystals: Power Laws
-/// with Continuous Parameters over the Size Spectrum, J. Atmos. Sci., 59, 1872-1884.
-struct Khvorostyanow_and_Curry_2002 {};
+typedef void Khvorostyanow_and_Curry_2002;
+
+/// @brief
+/// A single parameter representation of hygroscopic growth and cloud condensation nucleus activity.
+/// Atmos. Chem. Phys., 7, 1961-1971.
+/// @details
+/// [Petters and Kreidenweis 2007]: http://dx.doi.org/10.5194/acp-7-1961-2007
+/// [Petters and Kreidenweis 2007][]
+typedef void Petters_and_Kreidenweis_2007;
/// @brief
+/// A Short Course in Cloud Physics, Third Edition
+/// @details
/// [Rogers and Yau 1989]: http://google.com/search?q=ISBN-13:+978-0750632157
/// [Rogers and Yau 1989][]
+typedef void Rogers_and_Yau_1989;
+
+/// @brief
+/// The super-droplet method for the numerical simulation of clouds and precipitation:
+/// a particle-based and probabilistic microphysics model coupled with a non-hydrostatic model.
+/// Quart. J. Royal Met. Soc., 135, 1307-1320.
/// @details
-/// A Short Course in Cloud Physics, Third Edition
-struct Rogers_and_Yau_1989 {};
+/// [Shima et al. 2009]: http://dx.doi.org/10.1002/qj.441
+/// [Shima et al. 2009][]
+typedef void Shima_et_al_2009;
+/// @brief
+/// A fully multidimensional positive definite advection transport algorithm with small implicit diffusion
+/// J. Comp. Phys., 54, 352-362.
+/// @details
+/// [Smolarkiewicz 1984]: http://dx.doi.org/10.1016/0021-9991(84)90121-9
+/// [Smolarkiewicz 1984][]
+typedef void Smolarkiewicz_1984;
View
13 src/doc.hpp
@@ -57,16 +57,3 @@
* @section sec_COPYING GNU General Public License version 3
* @verbinclude "../COPYING"
*/
-
-/// central reference list for the documentation
-namespace bib
-{
- /// @brief
- /// [Khvorostyanow and Curry 2002]: http://dx.doi.org/10.1175/1520-0469(2002)059%3C1872:TVODAC%3E2.0.CO;2
- /// [Khvorostyanow and Curry 2002][]
- ///
- /// [Khvorostyanow and Curry 2002]: http://dx.doi.org/10.1175/1520-0469(2002)059%3C1872:TVODAC%3E2.0.CO;2
- struct Khvorostyanow_and_Curry_2002 {}
- {
- }
-}
View
9 src/eqs_todo_sdm.hpp
@@ -5,6 +5,7 @@
* @date April-June 2012
* @section LICENSE
* GPLv3+ (see the COPYING file or http://www.gnu.org/licenses/)
+ * @brief definition of the eqs_todo_sdm class
*/
#ifndef EQS_TODO_SDM_HPP
# define EQS_TODO_SDM_HPP
@@ -21,10 +22,10 @@
# include "sdm_ode_xi.hpp"
# include "sdm_ode_xy.hpp"
-// @brief
-// implementation of the Super-Droplet Method (Shima et al. 2009, QJRMS, 135)
-// with kappa-Koehler parameterisation of aerosol solubility (Patters and Kreidenweis 2007, ACP, 7)
-// and ...
+/// @brief
+/// implementation of the Super-Droplet Method (@copydetails Shima_et_al_2009, QJRMS, 135)
+/// with kappa-Koehler parameterisation of aerosol solubility (@copydetails Petters_and_Kreidenweis_2007, ACP, 7)
+/// and ...
template <typename real_t>
class eqs_todo_sdm : public eqs_todo<real_t>
{
View
32 src/phc_kappa_koehler.hpp
@@ -12,23 +12,21 @@
namespace phc
{
- // equilibrium wet radius to the third power for a given:
- // - dry radius to the third power
- // - the solubility parameter kappa
- // - ratio of
- // - abmient vapour density/pressure to
- // - saturation vapour density/pressure for pure water
- //
- // the formula stems from applying the kappa-Koehler relation
- // (eq. 6 in Petters and Kreidenweis 2007) to a stationarity
- // condition for a vapour diffusion equation, which translates to
- // zero differece of vapour density: rho_ambient - rho_surface = 0
- //
- // since rho_surface = rho_surface_pure_water * a(r_w, r_d, kappa)
- // one can derive r_w as a function of r_d, kappa and the ratio
- // of abmient and surface vapour densities
- //
- // for the kappa-Koehler parameterisation rw3 is linear with rd3
+ /// @brief equilibrium wet radius to the third power for a given:
+ /// @arg dry radius to the third power
+ /// @arg the solubility parameter kappa
+ /// @arg ratio of abmient vapour density/pressure to saturation vapour density/pressure for pure water
+ ///
+ /// the formula stems from applying the kappa-Koehler relation
+ /// (eq. 6 in @copydetails Petters_and_Kreidenweis_2007) to a stationarity
+ /// condition for a vapour diffusion equation, which translates to
+ /// zero differece of vapour density: rho_ambient - rho_surface = 0
+ ///
+ /// since rho_surface = rho_surface_pure_water * a(r_w, r_d, kappa)
+ /// one can derive r_w as a function of r_d, kappa and the ratio
+ /// of abmient and surface vapour densities
+ ///
+ /// for the kappa-Koehler parameterisation rw3 is linear with rd3
phc_declare_funct_macro quantity<si::volume, real_t> rw3_eq(
quantity<si::volume, real_t> rd3,
quantity<si::dimensionless, real_t> kappa,
View
10 src/phc_terminal_vel.hpp
@@ -11,7 +11,7 @@
# include "phc.hpp"
namespace phc
{
- /// @brief dynamic viscosity of air (@copybrief Rogers_and_Yau_1989 third edition page 102)
+ /// @brief dynamic viscosity of air (@copydetails Rogers_and_Yau_1989 third edition page 102)
/// temp in K and rhoa in kg/m3
phc_declare_funct_macro quantity<si::dynamic_viscosity, real_t> visc(
quantity<si::temperature, real_t> T)
@@ -22,7 +22,7 @@ namespace phc
// terminal fall velocity of spherical droplets
// TODO add another parametrisation for larger (nonspherical) drops
- // for derivation see @copybrief Khvorostyanov_and_Curry_2002 J. Atmos. Sci
+ // for derivation see @copydetails Khvorostyanov_and_Curry_2002 J. Atmos. Sci
phc_declare_funct_macro quantity<si::velocity, real_t> vt(
quantity<si::length, real_t> r, //radius
quantity<si::temperature, real_t> T, //temperature
@@ -31,20 +31,20 @@ namespace phc
{
quantity<si::mass_density, real_t> rhow = real_t(999) * si::kilograms / si::cubic_metres ;
- /// Best number (eq 2.7 in @copybrief Khvorostyanov_and_Curry_2002 J. Atmos. Sci)
+ /// Best number (eq 2.7 in @copydetails Khvorostyanov_and_Curry_2002 J. Atmos. Sci)
/// with maximum projected cross-sectional area parametrised as for spherical droplets (A=pi/4*D^2)
quantity<si::dimensionless, real_t> X = real_t(32./3) * (rhow-rhoa)/rhoa * phc::g<real_t>()
* r * r * r / visc(T) / visc(T) * rhoa * rhoa; //TODO use pow<>()
/// terminal velocity parametrisation coeffs
- /// eqs 2.12, 2.13 in @copybrief Khvorostyanov_and_Curry_2002 J. Atmos. Sci
+ /// eqs 2.12, 2.13 in @copydetails Khvorostyanov_and_Curry_2002 J. Atmos. Sci
quantity<si::dimensionless, real_t> b = real_t(.0902/2) * sqrt(X)
* pow(sqrt(real_t(1)+real_t(.0902)*sqrt(X))-real_t(1), -1)
* pow(sqrt(real_t(1)+real_t(.0902)*sqrt(X)), -1) ;
quantity<si::dimensionless, real_t> a = real_t(9.06 * 9.06 / 4)
* pow(sqrt(real_t(1)+real_t(.0902)*sqrt(X))-real_t(1), 2) / pow(X,b) ;
- /// eq 3.1 in @copybrief Khvorostyanov_and_Curry_2002 J. Atmos. Sci
+ /// eq 3.1 in @copydetails Khvorostyanov_and_Curry_2002 J. Atmos. Sci
quantity<si::dimensionless, real_t> Av = a
* pow(visc(T) / rhoa * real_t(1e4) * si::seconds / si::square_metres, real_t(1)-real_t(2)*b)
* pow(real_t(4./3) * rhow / rhoa * phc::g<real_t>() *real_t(1e2)* si::seconds * si::seconds / si::metres, b) ;
View
2 tests/adv_anderson_fattahi_1973/test_adv_anderson_fattahi_1973.cpp
@@ -7,7 +7,7 @@
* @section LICENSE
* GPLv3+ (see the COPYING file or http://www.gnu.org/licenses/)
* @section DESCRIPTION
- Rotating cone test from Anderson and Fattahi 1973 J. Atmos. Sci.
+ Rotating cone test from @copydetails Anderson_and_Fattahi_1974 J. Atmos. Sci.
* @section RESULTS
* \include "adv_anderson_fattahi_1973/test_adv_anderson_fattahi_1973.py"
* \image html "../../tests/adv_anderson_fattahi_1973/fig-leapfrog-2d.gif"
View
2 tests/phc_terminal_vel/term_vel_test.cpp
@@ -7,7 +7,7 @@
* GPLv3+ (see the COPYING file or http://www.gnu.org/licenses/)
* @section DESCRIPTION
* Tests the terminal velocity parametersiation implemented in phc_terminal_vel.hpp
- * following @copybrief Khvorostyanow_and_Curry_2002 (cf. solid line in Figure 2 therein)
+ * following @copydetails Khvorostyanow_and_Curry_2002 (cf. solid line in Figure 2 therein)
*
* \image html "../../tests/phc_terminal_vel/term_vel_test.svg"
*/

0 comments on commit 5f700a3

Please sign in to comment.