ERF_AerosolOpticalDepth.H File Reference

Prescribed bulk aerosol/turbidity optical depth diagnosis. More...

#include <AMReX_GpuControl.H>
#include <AMReX_Math.H>
#include <AMReX_FArrayBox.H>
#include <cmath>

Include dependency graph for ERF_AerosolOpticalDepth.H:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	diagnose_tau_aerosol_constant (amrex::Real tau_aerosol_const)
	Diagnose aerosol optical depth for Constant profile. More...
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	diagnose_tau_aerosol_exponential (amrex::Real z_level, amrex::Real dz, amrex::Real tau_surface, amrex::Real scale_height_m)
	Diagnose aerosol optical depth for Exponential profile. More...
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real	diagnose_tau_aerosol_table (int k)
	Diagnose aerosol optical depth for the Table profile. More...

Detailed Description

Prescribed bulk aerosol/turbidity optical depth diagnosis.

Implements profile-based aerosol optical depth diagnosis for use in TwoStream radiation. Supports Constant, Exponential, and Table (future) profile types.

Aerosol optical depth is added on top of existing tau contributions (tau_base + tau_cloud + tau_dynamic).

Constant profile: tau_aerosol(k) = aerosol_tau_per_layer [uniform at all levels]

Exponential profile: tau_aerosol(k) = aerosol_tau_surface * exp(-z(k) / aerosol_scale_height_m) [decay with height]

Table profile (future): tau_aerosol(k) = lookup_table[k] [per-level prescribed values]

References:

Function Documentation

diagnose_tau_aerosol_constant()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real diagnose_tau_aerosol_constant

(

amrex::Real

tau_aerosol_const

)

Diagnose aerosol optical depth for Constant profile.

Returns uniform aerosol tau_per_layer (independent of height/level). Clamped to [0, 100] for physical reasonableness.

Parameters

[in]

tau_aerosol_const

Constant aerosol optical depth per layer [dimensionless]

Returns

Clamped aerosol optical depth [0, 100]

{
    // Guard against invalid input
    if (!amrex::Math::isfinite(tau_aerosol_const)) {
        return 0.0;
    }
 
    // Clamp to physically reasonable range [0, 100]
    amrex::Real tau_clipped = tau_aerosol_const;
    if (tau_clipped < 0.0) tau_clipped = 0.0;
    if (tau_clipped > 100.0) tau_clipped = 100.0;
 
    return tau_clipped;
}

Referenced by diagnose_layer_tau().

Here is the caller graph for this function:

diagnose_tau_aerosol_exponential()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real diagnose_tau_aerosol_exponential	(	amrex::Real	z_level,
		amrex::Real	dz,
		amrex::Real	tau_surface,
		amrex::Real	scale_height_m
	)

Diagnose aerosol optical depth for Exponential profile.

Returns the optical depth of one layer of an exponentially decaying aerosol profile, i.e. the profile integrated across that layer, tau_aerosol(k) = (tau_surface / scale_height) * dz * exp(-z(k) / scale_height) so the column sum approaches tau_surface once the domain is much deeper than the scale height. This is a per-layer contribution, not the column value above z(k).

Clamped to [0, 100] for physical reasonableness. Handles invalid parameters safely with fallback to 0.

Parameters

[in]	z_level	Height at level k [m]
[in]	dz	Thickness of layer k [m]
[in]	tau_surface	Total-column aerosol optical depth at surface [dimensionless]
[in]	scale_height_m	Decay scale height [m]

Returns

Clamped aerosol optical depth [0, 100]

{
    if (!amrex::Math::isfinite(z_level) || !amrex::Math::isfinite(dz) ||
        !amrex::Math::isfinite(tau_surface) || !amrex::Math::isfinite(scale_height_m)) {
        return 0.0;
    }
    if (scale_height_m <= 0.0 || dz <= 0.0) {
        return 0.0;
    }
    if (tau_surface < 0.0) {
        return 0.0;
    }
    if (z_level < 0.0) {
        z_level = 0.0;
    }
 
    amrex::Real arg = -z_level / scale_height_m;
    if (arg < -100.0) {
        return 0.0;
    }
 
    // Per-layer contribution = (tau_surface / scale_height) * dz * exp(-z/H)
    // so the vertical integral over all layers approaches tau_surface as domain height >> H
    amrex::Real tau_aerosol = (tau_surface / scale_height_m) * dz * std::exp(arg);
 
    if (tau_aerosol < 0.0)   tau_aerosol = 0.0;
    if (tau_aerosol > 100.0) tau_aerosol = 100.0;
 
    return tau_aerosol;
}

Referenced by diagnose_layer_tau().

Here is the caller graph for this function:

diagnose_tau_aerosol_table()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real diagnose_tau_aerosol_table

(

int

k

)

Diagnose aerosol optical depth for the Table profile.

Not implemented: a per-level table lookup would be supplied through a fixed-size array or a MultiFab. RadChoice::init_params() rejects this profile type, so this function is unreachable from a configured run.

Parameters

[in]

k

Level index

Returns

Zero

{
    // Future extension: implement per-level table lookup
    // For now, return 0 (no contribution)
    (void)k;  // Suppress unused parameter warning
    return 0.0;
}

Referenced by diagnose_layer_tau().

Here is the caller graph for this function: