Workspace functions for the solution of cloud-box radiative transfer by Monte Carlo methods. All of these functions refer to 3D calculations. More...

#include "messages.h"
#include "arts.h"
#include "auto_md.h"
#include "ppath.h"
#include "matpackI.h"
#include "special_interp.h"
#include "check_input.h"
#include <stdexcept>
#include <cmath>
#include "rte.h"
#include "lin_alg.h"
#include "logic.h"
#include "physics_funcs.h"
#include "xml_io.h"
#include "montecarlo.h"
#include "rng.h"
#include <ctime>
#include <fstream>
#include "mc_interp.h"
#include "math_funcs.h"

Functions
void	mc_antennaSetGaussian (MCAntenna &mc_antenna, const Numeric &za_sigma, const Numeric &aa_sigma, const Verbosity &)
	WORKSPACE METHOD: mc_antennaSetGaussian. More...

void	mc_antennaSetGaussianByFWHM (MCAntenna &mc_antenna, const Numeric &za_fwhm, const Numeric &aa_fwhm, const Verbosity &)
	WORKSPACE METHOD: mc_antennaSetGaussianByFWHM. More...

void	mc_antennaSetPencilBeam (MCAntenna &mc_antenna, const Verbosity &)
	WORKSPACE METHOD: mc_antennaSetPencilBeam. More...

void	MCGeneral (Workspace &ws, Vector &y, Index &mc_iteration_count, Vector &mc_error, Tensor3 &mc_points, const MCAntenna &mc_antenna, const Vector &f_grid, const Index &f_index, const Matrix &sensor_pos, const Matrix &sensor_los, const Index &stokes_dim, const Index &atmosphere_dim, const Agenda &ppath_step_agenda, const Numeric &ppath_lraytrace, const Agenda &iy_space_agenda, const Agenda &surface_rtprop_agenda, const Agenda &propmat_clearsky_agenda, const Vector &p_grid, const Vector &lat_grid, const Vector &lon_grid, const Tensor3 &z_field, const Vector &refellipsoid, const Matrix &z_surface, const Tensor3 &t_field, const Tensor4 &vmr_field, const Index &cloudbox_on, const ArrayOfIndex &cloudbox_limits, const Tensor4 &pnd_field, const ArrayOfSingleScatteringData &scat_data_array_mono, const Index &atmfields_checked, const Index &atmgeom_checked, const Index &cloudbox_checked, const Index &mc_seed, const String &y_unit, const Numeric &std_err, const Index &max_time, const Index &max_iter, const Index &min_iter, const Verbosity &verbosity)
	WORKSPACE METHOD: MCGeneral. More...

void	MCSetSeedFromTime (Index &mc_seed, const Verbosity &)
	WORKSPACE METHOD: MCSetSeedFromTime. More...

Variables
const Numeric	DEG2RAD

const Numeric	RAD2DEG

const Numeric	PI

const Numeric	BOLTZMAN_CONST

const Numeric	SPEED_OF_LIGHT

Detailed Description

Workspace functions for the solution of cloud-box radiative transfer by Monte Carlo methods. All of these functions refer to 3D calculations.

Author: Cory Davis cory@.nosp@m.met..nosp@m.ed.ac.nosp@m..uk

Date: 2003-06-19

These functions are listed in the doxygen documentation as entries of the file auto_md.h.

Definition in file m_montecarlo.cc.

Function Documentation

◆ mc_antennaSetGaussian()

void mc_antennaSetGaussian	(	MCAntenna &	mc_antenna,
		const Numeric &	za_sigma,
		const Numeric &	aa_sigma,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: mc_antennaSetGaussian.

Makes mc_antenna (used by MCGeneral) a 2D Gaussian pattern.

The gaussian antenna pattern is determined by za_sigma and aa_sigma*, which represent the standard deviations in the uncorrelated bivariate normal distribution.

Author: Cory Davis

Parameters

[out]	mc_antenna	WS Output
[in]	za_sigma	Generic Input
[in]	aa_sigma	Generic Input

Definition at line 73 of file m_montecarlo.cc.

References MCAntenna::set_gaussian().

Referenced by mc_antennaSetGaussian_g().

◆ mc_antennaSetGaussianByFWHM()

void mc_antennaSetGaussianByFWHM	(	MCAntenna &	mc_antenna,
		const Numeric &	za_fwhm,
		const Numeric &	aa_fwhm,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: mc_antennaSetGaussianByFWHM.

Makes mc_antenna (used by MCGeneral) a 2D Gaussian pattern.

The gaussian antenna pattern is determined by za_fwhm and aa_fwhm*, which represent the full width half maximum (FWHM) of the antenna response, in the zenith and azimuthal planes.

Author: Cory Davis

Parameters

[out]	mc_antenna	WS Output
[in]	za_fwhm	Generic Input
[in]	aa_fwhm	Generic Input

Definition at line 84 of file m_montecarlo.cc.

References MCAntenna::set_gaussian_fwhm().

Referenced by mc_antennaSetGaussianByFWHM_g().

◆ mc_antennaSetPencilBeam()

void mc_antennaSetPencilBeam	(	MCAntenna &	mc_antenna,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: mc_antennaSetPencilBeam.

Makes mc_antenna (used by MCGeneral) a pencil beam.

This WSM makes the subsequent MCGeneral WSM perform pencil beam RT calculations.

Author: Cory Davis

Parameters

[out] mc_antenna WS Output

Definition at line 95 of file m_montecarlo.cc.

References MCAntenna::set_pencil_beam().

Referenced by mc_antennaSetPencilBeam_g().

◆ MCGeneral()

void MCGeneral	(	Workspace &	ws,
		Vector &	y,
		Index &	mc_iteration_count,
		Vector &	mc_error,
		Tensor3 &	mc_points,
		const MCAntenna &	mc_antenna,
		const Vector &	f_grid,
		const Index &	f_index,
		const Matrix &	sensor_pos,
		const Matrix &	sensor_los,
		const Index &	stokes_dim,
		const Index &	atmosphere_dim,
		const Agenda &	ppath_step_agenda,
		const Numeric &	ppath_lraytrace,
		const Agenda &	iy_space_agenda,
		const Agenda &	surface_rtprop_agenda,
		const Agenda &	propmat_clearsky_agenda,
		const Vector &	p_grid,
		const Vector &	lat_grid,
		const Vector &	lon_grid,
		const Tensor3 &	z_field,
		const Vector &	refellipsoid,
		const Matrix &	z_surface,
		const Tensor3 &	t_field,
		const Tensor4 &	vmr_field,
		const Index &	cloudbox_on,
		const ArrayOfIndex &	cloudbox_limits,
		const Tensor4 &	pnd_field,
		const ArrayOfSingleScatteringData &	scat_data_array_mono,
		const Index &	atmfields_checked,
		const Index &	atmgeom_checked,
		const Index &	cloudbox_checked,
		const Index &	mc_seed,
		const String &	iy_unit,
		const Numeric &	mc_std_err,
		const Index &	mc_max_time,
		const Index &	mc_max_iter,
		const Index &	mc_min_iter,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: MCGeneral.

A generalised 3D reversed Monte Carlo radiative algorithm, that allows for 2D antenna patterns, surface reflection and arbitrary sensor positions.

The main output variables y and mc_error represent the Stokes vector integrated over the antenna function, and the estimated error in this vector, respectively.

The WSV mc_max_iter describes the maximum number of ‘photons’ used in the simulation (more photons means smaller mc_error). mc_std_err* is the desired value of mc_error. mc_max_time is the maximum allowed number of seconds for MCGeneral. The method will terminate once any of the max_iter, std_err, max_time criteria are met. If negative values are given for these parameters then it is ignored.

The WSV mc_min_iter sets the minimum number of photons to apply before the condition set by mc_std_err is considered. Values of mc_min_iter below 100 are not accepted.

Negative values of mc_seed seed the random number generator according to system time, positive mc_seed values are taken literally.

Only "1" and "RJBT" are allowed for iy_unit. The value of mc_error* follows the selection for iy_unit (both for in- and output.

Author: Cory Davis

Parameters

[in,out]	ws	Workspace
[out]	y	WS Output
[out]	mc_iteration_count	WS Output
[out]	mc_error	WS Output
[out]	mc_points	WS Output
[in]	mc_antenna	WS Input
[in]	f_grid	WS Input
[in]	f_index	WS Input
[in]	sensor_pos	WS Input
[in]	sensor_los	WS Input
[in]	stokes_dim	WS Input
[in]	atmosphere_dim	WS Input
[in]	ppath_step_agenda	WS Input
[in]	ppath_lraytrace	WS Input
[in]	iy_space_agenda	WS Input
[in]	surface_rtprop_agenda	WS Input
[in]	propmat_clearsky_agenda	WS Input
[in]	p_grid	WS Input
[in]	lat_grid	WS Input
[in]	lon_grid	WS Input
[in]	z_field	WS Input
[in]	refellipsoid	WS Input
[in]	z_surface	WS Input
[in]	t_field	WS Input
[in]	vmr_field	WS Input
[in]	cloudbox_on	WS Input
[in]	cloudbox_limits	WS Input
[in]	pnd_field	WS Input
[in]	scat_data_array_mono	WS Input
[in]	atmfields_checked	WS Input
[in]	atmgeom_checked	WS Input
[in]	cloudbox_checked	WS Input
[in]	mc_seed	WS Input
[in]	iy_unit	WS Input
[in]	mc_std_err	WS Input
[in]	mc_max_time	WS Input
[in]	mc_max_iter	WS Input
[in]	mc_min_iter	WS Input

Definition at line 103 of file m_montecarlo.cc.

References BOLTZMAN_CONST, chk_if_in_range(), CREATE_OUT0, Rng::draw(), MCAntenna::draw_los(), findZ11max(), Ppath::gp_lat, Ppath::gp_lon, Ppath::gp_p, id_mat(), invrayjean(), is_anyptype30(), iy_space_agendaExecute(), joker, mcPathTraceGeneral(), mult(), ConstTensor4View::nbooks(), ConstMatrixView::ncols(), ConstVectorView::nelem(), Ppath::np, ConstMatrixView::nrows(), planck(), q, Vector::resize(), Tensor3::resize(), Sample_los(), Rng::seed(), SPEED_OF_LIGHT, and surface_rtprop_agendaExecute().

Referenced by iyMC(), and MCGeneral_g().

◆ MCSetSeedFromTime()

void MCSetSeedFromTime	(	Index &	mc_seed,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: MCSetSeedFromTime.

Sets the value of mc_seed from system time

Author: Cory Davis

Parameters

[out] mc_seed WS Output

Definition at line 448 of file m_montecarlo.cc.

Referenced by iyMC(), and MCSetSeedFromTime_g().

Variable Documentation

◆ BOLTZMAN_CONST

const Numeric BOLTZMAN_CONST

extern

Referenced by MCGeneral().

◆ DEG2RAD

const Numeric DEG2RAD

extern

◆ PI

const Numeric PI

extern

◆ RAD2DEG

const Numeric RAD2DEG

extern

◆ SPEED_OF_LIGHT

const Numeric SPEED_OF_LIGHT

extern

Referenced by MCGeneral().

Functions

Variables

Detailed Description

Function Documentation

◆ mc_antennaSetGaussian()

◆ mc_antennaSetGaussianByFWHM()

◆ mc_antennaSetPencilBeam()

◆ MCGeneral()

◆ MCSetSeedFromTime()

Variable Documentation

◆ BOLTZMAN_CONST

◆ DEG2RAD

◆ PI

◆ RAD2DEG

◆ SPEED_OF_LIGHT