tympan::SolverConfiguration Class Reference

Class to define a solver configuration (contains all the data needed by the different Tympan solvers) More...

#include <config.h>

Public Member Functions
	SolverConfiguration ()
	Constructor. More...
	~SolverConfiguration ()
	Destructor. More...

Static Public Member Functions
static LPSolverConfiguration	get ()
	Get the configuration. More...
static void	set (LPSolverConfiguration config)
	Set a configuration. More...

Public Attributes
double	AtmosPressure
	Atmospheric pressure [Pa]. More...
double	AtmosTemperature
	Atmospheric temperature [°C]. More...
double	AtmosHygrometry
	Atmospheric hygrometry. More...
double	WindDirection
	Wind direction. More...
double	AnalyticGradC
	Sound speed gradient. More...
double	AnalyticGradV
	Wind gradient. More...
int	RayTracingOrder
int	Discretization
int	NbRaysPerSource
	Number of rays per source for the Sampler. More...
float	MaxLength
	LengthSelector Selector option (maximal length) More...
float	SizeReceiver
int	Accelerator
int	MaxTreeDepth
	BvhAccelerator Accelerator option (Maximal tree depth) More...
float	AngleDiffMin
float	CylindreThick
	Diffraction cylinder diameter. More...
int	MaxProfondeur
	Maximal number of events for ray validation in ANIME3D solver. More...
bool	UseSol
	Flag to activate specular reflection on the ground. More...
int	MaxReflexion
	Maximal reflection events. More...
int	MaxDiffraction
	Maximal diffraction events. More...
bool	DiffractionUseRandomSampler
	Flag to enable random (and not regular) sampling for diffraction. More...
int	NbRayWithDiffraction
	Number of rays to throw during diffraction. More...
bool	DiffractionDropDownNbRays
bool	DiffractionFilterRayAtCreation
	Flag to filter the created rays during diffraction. More...
bool	UsePathDifValidation
	Flag to activate path validations during diffraction. More...
float	MaxPathDifference
	Parameter (by default 24) for path validations during diffraction. More...
bool	DiffractionUseDistanceAsFilter
bool	KeepDebugRay
	Flag to store rays into a debug_rays array after being invalidated. More...
bool	UsePostFilters
	Flag to use some specifics Selector. More...
int	CurveRaySampler
	Not used. More...
float	InitialAngleTheta
	Starting angle theta for the curve ray sampler. More...
float	FinalAngleTheta
	Ending angle theta for the curve ray sampler. More...
float	InitialAnglePhi
	Starting angle phi for the curve ray sampler. More...
float	FinalAnglePhi
	Ending angle phi for the curve ray sampler. More...
int	AnalyticNbRay
	Rays number to launch for the curve ray sampler. More...
double	AnalyticTMax
	The maximal propagation time for the curve ray sampler. More...
double	AnalyticH
	The propagation time step for the curve ray sampler. More...
double	AnalyticDMax
	The maximal distance for the curve ray sampler. More...
int	AnalyticTypeTransfo
float	MeshElementSizeMax
	Not used. More...
bool	RefineMesh
bool	UseVolumesLandtake
bool	showScene
	Flag to export Scene in order to visualize it. More...
float	MinSRDistance
	Not used. More...
int	NbThreads
	Number of threads used by TYSolver. More...
bool	UseRealGround
	Flag to model ground into the acoustic model. More...
bool	UseScreen
	Not used. More...
bool	UseLateralDiffraction
	Flag to compute horizontal paths in the acoustic path finder. More...
bool	UseReflection
	Flag to use reflection on vertical walls. More...
int	PropaConditions
float	DSWindDirection
float	AngleFavorable
float	AngleDefavorable
bool	KeepRays
	Flag to keep the rays in the results. More...
float	H1parameter
	Multiplicative coefficient for the additional reflections if PropaConditions is true. More...
bool	ModSummation
	Flag to activate in the acoustic model a calculation with interference. More...
bool	DebugUseCloseEventSelector
	Flag to add the the CloseEventSelector filter. More...
bool	DebugUseDiffractionAngleSelector
	Flag to add the DiffractionAngleSelector filter. More...
bool	DebugUseDiffractionPathSelector
	Flag to add the DiffractionPathSelector filter. More...
bool	DebugUseFermatSelector
	Flag to add the FermatSelector filter. More...
bool	DebugUseFaceSelector
	Flag to add the FaceSelector filter. More...

Static Private Attributes
static LPSolverConfiguration	_pInstance = 0

Detailed Description

Class to define a solver configuration (contains all the data needed by the different Tympan solvers)

Definition at line 21 of file config.h.

Constructor & Destructor Documentation

SolverConfiguration()

tympan::SolverConfiguration::SolverConfiguration

(

)

Constructor.

< Not used

Definition at line 24 of file config.cpp.

Here is the caller graph for this function:

~SolverConfiguration()

tympan::SolverConfiguration::~SolverConfiguration

(

)

Destructor.

Definition at line 107 of file config.cpp.

Member Function Documentation

get()

LPSolverConfiguration tympan::SolverConfiguration::get ( )

static

Get the configuration.

Definition at line 93 of file config.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

set()

void tympan::SolverConfiguration::set ( LPSolverConfiguration  config )

static

Set a configuration.

Definition at line 102 of file config.cpp.

Here is the caller graph for this function:

Member Data Documentation

_pInstance

LPSolverConfiguration tympan::SolverConfiguration::_pInstance = 0

staticprivate

Definition at line 108 of file config.h.

Accelerator

int tympan::SolverConfiguration::Accelerator

Accelerator choice with 0: BruteForceAccelerator, 1: GridAccelerator, 2: BvhAccelerator, 3: KdtreeAccelerator

Definition at line 38 of file config.h.

AnalyticDMax

double tympan::SolverConfiguration::AnalyticDMax

The maximal distance for the curve ray sampler.

Definition at line 68 of file config.h.

AnalyticGradC

double tympan::SolverConfiguration::AnalyticGradC

Sound speed gradient.

Definition at line 28 of file config.h.

AnalyticGradV

double tympan::SolverConfiguration::AnalyticGradV

Wind gradient.

Definition at line 29 of file config.h.

AnalyticH

double tympan::SolverConfiguration::AnalyticH

The propagation time step for the curve ray sampler.

Definition at line 67 of file config.h.

AnalyticNbRay

int tympan::SolverConfiguration::AnalyticNbRay

Rays number to launch for the curve ray sampler.

Definition at line 65 of file config.h.

AnalyticTMax

double tympan::SolverConfiguration::AnalyticTMax

The maximal propagation time for the curve ray sampler.

Definition at line 66 of file config.h.

AnalyticTypeTransfo

int tympan::SolverConfiguration::AnalyticTypeTransfo

Type of geometry modifier used (only one for the moment: geometry_modifier_z_correction)

Definition at line 70 of file config.h.

AngleDefavorable

float tympan::SolverConfiguration::AngleDefavorable

Definition at line 88 of file config.h.

AngleDiffMin

float tympan::SolverConfiguration::AngleDiffMin

Minimal angle (other PI) between two face to allow building of a diffraction cylinder

Definition at line 41 of file config.h.

AngleFavorable

float tympan::SolverConfiguration::AngleFavorable

Definition at line 87 of file config.h.

AtmosHygrometry

double tympan::SolverConfiguration::AtmosHygrometry

Atmospheric hygrometry.

Definition at line 26 of file config.h.

AtmosPressure

double tympan::SolverConfiguration::AtmosPressure

Atmospheric pressure [Pa].

Definition at line 24 of file config.h.

AtmosTemperature

double tympan::SolverConfiguration::AtmosTemperature

Atmospheric temperature [°C].

Definition at line 25 of file config.h.

CurveRaySampler

int tympan::SolverConfiguration::CurveRaySampler

Not used.

Definition at line 60 of file config.h.

CylindreThick

float tympan::SolverConfiguration::CylindreThick

Diffraction cylinder diameter.

Definition at line 43 of file config.h.

DebugUseCloseEventSelector

bool tympan::SolverConfiguration::DebugUseCloseEventSelector

Flag to add the the CloseEventSelector filter.

Definition at line 95 of file config.h.

DebugUseDiffractionAngleSelector

bool tympan::SolverConfiguration::DebugUseDiffractionAngleSelector

Flag to add the DiffractionAngleSelector filter.

Definition at line 96 of file config.h.

DebugUseDiffractionPathSelector

bool tympan::SolverConfiguration::DebugUseDiffractionPathSelector

Flag to add the DiffractionPathSelector filter.

Definition at line 97 of file config.h.

DebugUseFaceSelector

bool tympan::SolverConfiguration::DebugUseFaceSelector

Flag to add the FaceSelector filter.

Definition at line 99 of file config.h.

DebugUseFermatSelector

bool tympan::SolverConfiguration::DebugUseFermatSelector

Flag to add the FermatSelector filter.

Definition at line 98 of file config.h.

DiffractionDropDownNbRays

bool tympan::SolverConfiguration::DiffractionDropDownNbRays

Flag to reduce the number of rays thrown depending on the diffraction order

Definition at line 50 of file config.h.

DiffractionFilterRayAtCreation

bool tympan::SolverConfiguration::DiffractionFilterRayAtCreation

Flag to filter the created rays during diffraction.

Definition at line 52 of file config.h.

DiffractionUseDistanceAsFilter

bool tympan::SolverConfiguration::DiffractionUseDistanceAsFilter

Flag to use distance based filter during diffraction (distance from the ridge)

Definition at line 55 of file config.h.

DiffractionUseRandomSampler

bool tympan::SolverConfiguration::DiffractionUseRandomSampler

Flag to enable random (and not regular) sampling for diffraction.

Definition at line 48 of file config.h.

Discretization

int tympan::SolverConfiguration::Discretization

Sampler choice with 0: RandomSphericSampler, 1: UniformSphericSampler, 2: UniformSphericSampler2, 3: Latitude2DSampler

Definition at line 33 of file config.h.

DSWindDirection

float tympan::SolverConfiguration::DSWindDirection

Definition at line 86 of file config.h.

FinalAnglePhi

float tympan::SolverConfiguration::FinalAnglePhi

Ending angle phi for the curve ray sampler.

Definition at line 64 of file config.h.

FinalAngleTheta

float tympan::SolverConfiguration::FinalAngleTheta

Ending angle theta for the curve ray sampler.

Definition at line 62 of file config.h.

H1parameter

float tympan::SolverConfiguration::H1parameter

Multiplicative coefficient for the additional reflections if PropaConditions is true.

Definition at line 92 of file config.h.

InitialAnglePhi

float tympan::SolverConfiguration::InitialAnglePhi

Starting angle phi for the curve ray sampler.

Definition at line 63 of file config.h.

InitialAngleTheta

float tympan::SolverConfiguration::InitialAngleTheta

Starting angle theta for the curve ray sampler.

Definition at line 61 of file config.h.

KeepDebugRay

bool tympan::SolverConfiguration::KeepDebugRay

Flag to store rays into a debug_rays array after being invalidated.

Definition at line 57 of file config.h.

KeepRays

bool tympan::SolverConfiguration::KeepRays

Flag to keep the rays in the results.

Definition at line 89 of file config.h.

MaxDiffraction

int tympan::SolverConfiguration::MaxDiffraction

Maximal diffraction events.

Definition at line 47 of file config.h.

MaxLength

float tympan::SolverConfiguration::MaxLength

LengthSelector Selector option (maximal length)

Definition at line 36 of file config.h.

MaxPathDifference

float tympan::SolverConfiguration::MaxPathDifference

Parameter (by default 24) for path validations during diffraction.

Definition at line 54 of file config.h.

MaxProfondeur

int tympan::SolverConfiguration::MaxProfondeur

Maximal number of events for ray validation in ANIME3D solver.

Definition at line 44 of file config.h.

MaxReflexion

int tympan::SolverConfiguration::MaxReflexion

Maximal reflection events.

Definition at line 46 of file config.h.

MaxTreeDepth

int tympan::SolverConfiguration::MaxTreeDepth

BvhAccelerator Accelerator option (Maximal tree depth)

Definition at line 40 of file config.h.

MeshElementSizeMax

float tympan::SolverConfiguration::MeshElementSizeMax

Not used.

Definition at line 72 of file config.h.

MinSRDistance

float tympan::SolverConfiguration::MinSRDistance

Not used.

Definition at line 77 of file config.h.

ModSummation

bool tympan::SolverConfiguration::ModSummation

Flag to activate in the acoustic model a calculation with interference.

Definition at line 93 of file config.h.

NbRaysPerSource

int tympan::SolverConfiguration::NbRaysPerSource

Number of rays per source for the Sampler.

Definition at line 35 of file config.h.

NbRayWithDiffraction

int tympan::SolverConfiguration::NbRayWithDiffraction

Number of rays to throw during diffraction.

Definition at line 49 of file config.h.

NbThreads

int tympan::SolverConfiguration::NbThreads

Number of threads used by TYSolver.

Definition at line 78 of file config.h.

PropaConditions

int tympan::SolverConfiguration::PropaConditions

Flag to check that reflections will be limited between source and receptors in the acoustic model

Definition at line 84 of file config.h.

RayTracingOrder

int tympan::SolverConfiguration::RayTracingOrder

Ray tracing order, with 0:S->R, 1:R->S, 2:Automatic (S->R if more sources than receptors, else R->S)

Definition at line 31 of file config.h.

RefineMesh

bool tympan::SolverConfiguration::RefineMesh

Definition at line 73 of file config.h.

showScene

bool tympan::SolverConfiguration::showScene

Flag to export Scene in order to visualize it.

Definition at line 75 of file config.h.

SizeReceiver

float tympan::SolverConfiguration::SizeReceiver

Definition at line 37 of file config.h.

UseLateralDiffraction

bool tympan::SolverConfiguration::UseLateralDiffraction

Flag to compute horizontal paths in the acoustic path finder.

Definition at line 82 of file config.h.

UsePathDifValidation

bool tympan::SolverConfiguration::UsePathDifValidation

Flag to activate path validations during diffraction.

Definition at line 53 of file config.h.

UsePostFilters

bool tympan::SolverConfiguration::UsePostFilters

Flag to use some specifics Selector.

Definition at line 58 of file config.h.

UseRealGround

bool tympan::SolverConfiguration::UseRealGround

Flag to model ground into the acoustic model.

Definition at line 79 of file config.h.

UseReflection

bool tympan::SolverConfiguration::UseReflection

Flag to use reflection on vertical walls.

Definition at line 83 of file config.h.

UseScreen

bool tympan::SolverConfiguration::UseScreen

Not used.

Definition at line 81 of file config.h.

UseSol

bool tympan::SolverConfiguration::UseSol

Flag to activate specular reflection on the ground.

Definition at line 45 of file config.h.

UseVolumesLandtake

bool tympan::SolverConfiguration::UseVolumesLandtake

Definition at line 74 of file config.h.

WindDirection

double tympan::SolverConfiguration::WindDirection

Wind direction.

Definition at line 27 of file config.h.

---

The documentation for this class was generated from the following files:

• /home/docs/checkouts/readthedocs.org/user_builds/code-tympan-fbessou/checkouts/latest/Tympan/models/solver/config.h
• /home/docs/checkouts/readthedocs.org/user_builds/code-tympan-fbessou/checkouts/latest/Tympan/models/solver/config.cpp