Classes
class	AcousticBuildingMaterial
	Describes building material. More...

class	AcousticGroundMaterial
	Describes the ground material, a specific AcousticBuildingMaterial. More...

class	AcousticMaterialBase
	Base class for material. More...

class	AcousticProblemModel
	Class to describe the acoustic problem. More...

class	AcousticReceptor
	Describes an acoustic receptor. More...

class	AcousticResultModel
	Contains the results of the model solved. More...

class	AcousticSource
	Describes an acoustic source. More...

class	AcousticTriangle
	Describing a triangle. More...

class	AltimetryPLYReader
	read an Altimetry from a PLY file. More...

class	BaffledFaceDirectivity
	Directivity for a baffled face. More...

class	BaseEntity
	The base of all entity classes. More...

class	ChimneyFaceDirectivity
	Directivity for a chimney face. More...

class	CommonFaceDirectivity
	BaseEntity class for directivity on face. More...

class	DirectivityCoefficient
	Directivity coefficient. More...

struct	exception
	The base exception class for all exceptions specific to Code_TYMPAN. More...

class	GlobalContribution
	Global contribution. More...

class	IMeshReader

struct	invalid_data
	The base exception class for errors due to invalid data. More...

class	ITYPolygonTriangulator

struct	logic_error
	The base exception class for internal logic / algorithmic errors. More...

struct	mesh_io_error

class	PolygonTriangulator
	This class provides triangulating simple polygons without holes. More...

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

class	SourceDirectivityInterface
	Interface for source directivity classes (SphericalSourceDirectivity, CommonFaceDirectivity, ...) More...

class	SpectrumMatrix
	Spectrum matrix N*M used to store results. N is the number of receptors. M is the number of sources. More...

class	SphericalSourceDirectivity
	Directivity for a spherical source. More...

class	TYPolygonTriangulator

class	VolumeFaceDirectivity
	Directivity for a volume face. More...

Typedefs
typedef boost::shared_ptr< SolverConfiguration >	LPSolverConfiguration

typedef boost::error_info< struct tag_elements_implied, std::deque< LPTYElement > >	elements_implied_errinfo

typedef boost::error_info< struct tag_position, OPoint3D >	position_errinfo

typedef boost::error_info< struct tag_classname, std::string >	oproto_classname_errinfo

typedef CGAL::Exact_predicates_inexact_constructions_kernel	CGAL_K

typedef CGAL_K	CGAL_Gt

typedef CGAL::Point_2< CGAL_Gt >	CGAL_Point2

typedef CGAL::Point_3< CGAL_Gt >	CGAL_Point3

typedef CGAL::Vector_2< CGAL_Gt >	CGAL_Vector2

typedef CGAL::Vector_3< CGAL_Gt >	CGAL_Vector3

typedef CGAL::Polygon_2< CGAL_Gt >	CGAL_Polygon

typedef CGAL::Plane_3< CGAL_Gt >	CGAL_Plane

typedef CGAL::Triangle_3< CGAL_Gt >	CGAL_Triangle

typedef std::deque< CGAL_Triangle >	CGAL_Triangles

typedef CGAL::Box_intersection_d::Box_with_handle_d< double, 3, CGAL_Triangles::iterator >	CGAL_TBox

typedef CGAL::Aff_transformation_3< CGAL_Gt >	CGAL_Transform3

typedef OSpectre	Spectrum

typedef OPoint3D	Point

typedef OVector3D	Vector

typedef OSpectreComplex	ComplexSpectrum

typedef std::deque< Point >	nodes_pool_t

typedef size_t	node_idx

typedef shared_ptr< AcousticMaterialBase >	material_ptr_t

typedef std::deque< material_ptr_t >	material_pool_t

typedef std::deque< AcousticTriangle >	triangle_pool_t
	Array of AcousticTriangle. More...

typedef size_t	triangle_idx

typedef std::deque< AcousticSource >	source_pool_t
	Array of sources. More...

typedef size_t	source_idx

typedef std::deque< AcousticReceptor >	receptor_pool_t
	Array of receptors. More...

typedef size_t	receptor_idx

Functions
std::unique_ptr< IMeshReader >	make_altimetry_ply_reader (const std::string filename)
	@ Makes a reader for the file name given as argument More...

std::unique_ptr< ITYPolygonTriangulator >	make_polygon_triangulator (const TYPolygon &poly)

void	init_registry ()

void	load_solvers (const char *path)
	Load the solver plugins found in `path` More...

SolverInterface *	select_solver (OGenID uuid)
	Select a solver amongst the loaded solvers (a previous call to tympan::load_solvers() is. More...

OGenID	solver_id (std::string name)
	Return the id of the solver named `name` (a previous call to tympan::load_solvers() is. More...

LPTYProjet	load_project (const char *filename)
	load an XML project file More...

void	save_project (const char *filename, const LPTYProjet &project)
	save a project into an XML file More...

std::vector< LPTYElement >	load_elements (const char *filename)
	load one or several objects from an xml file More...

CGAL_Plane	to_cgal (const OPlan &oplan)
	Convert a OPlan to CGAL_Plane. More...

CGAL_Vector3	normalize (CGAL_Vector3 v)
	normalize vector v More...

std::deque< CGAL_Point3 >	build_box (float w, float h, CGAL_Point3 pta, CGAL_Point3 ptb)
	return 4 points defining a 3D parallelepiped More...

void	intersection_report (std::deque< size_t > *intersected, CGAL_Triangles::iterator start_index, const CGAL_TBox &a, const CGAL_TBox &b)

std::deque< size_t >	intersected_triangles (CGAL_Triangles &triangle_soup, std::deque< CGAL_Point3 > query_triangle, float l, float w, float h)
	Find the triangles from `triangle_soup` that are intersected by the 3D box including the points of `query_triangle` More...

OPoint3D	from_cgal (const CGAL_Point3 &cp)
	Convert a CGAL_Point3 to OPoint3D. More...

CGAL_Point3	to_cgal (const OPoint3D &op)
	Convert a OPoint3D to a CGAL_Point3. More...

OVector3D	from_cgal (const CGAL_Vector3 &cp)
	Convert a CGAL_Vector3 to OVector3D. More...

CGAL_Vector3	to_cgal (const OVector3D &op)
	Convert a OVector3D to CGAL_Vector3. More...

deque< triangle_idx >	scene_volume_intersection (const triangle_pool_t &triangles, const nodes_pool_t &nodes, float l, float h, OPoint3D source, OPoint3D receptor)
	Find the intersection between some triangles (`triangles`, `nodes`) and a volume given by a width, a height and 2 points delimiting the length. The volume is centered on the midpoint between the source and the receptor. More...

std::unique_ptr< AcousticProblemModel >	make_AcousticProblemModel ()

std::unique_ptr< AcousticResultModel >	make_AcousticResultModel ()

Point	ComputeAcousticCentroid (const source_pool_t &tabSources_)

Typedef Documentation

◆ CGAL_Gt

typedef CGAL_K tympan::CGAL_Gt

Definition at line 44 of file cgal_tools.h.

◆ CGAL_K

typedef CGAL::Exact_predicates_inexact_constructions_kernel tympan::CGAL_K

Definition at line 43 of file cgal_tools.h.

◆ CGAL_Plane

typedef CGAL::Plane_3<CGAL_Gt> tympan::CGAL_Plane

Definition at line 50 of file cgal_tools.h.

◆ CGAL_Point2

typedef CGAL::Point_2<CGAL_Gt> tympan::CGAL_Point2

Definition at line 45 of file cgal_tools.h.

◆ CGAL_Point3

typedef CGAL::Point_3<CGAL_Gt> tympan::CGAL_Point3

Definition at line 46 of file cgal_tools.h.

◆ CGAL_Polygon

typedef CGAL::Polygon_2<CGAL_Gt> tympan::CGAL_Polygon

Definition at line 49 of file cgal_tools.h.

◆ CGAL_TBox

typedef CGAL::Box_intersection_d::Box_with_handle_d<double,3,CGAL_Triangles::iterator> tympan::CGAL_TBox

Definition at line 53 of file cgal_tools.h.

◆ CGAL_Transform3

typedef CGAL::Aff_transformation_3<CGAL_Gt> tympan::CGAL_Transform3

Definition at line 54 of file cgal_tools.h.

◆ CGAL_Triangle

typedef CGAL::Triangle_3<CGAL_Gt> tympan::CGAL_Triangle

Definition at line 51 of file cgal_tools.h.

◆ CGAL_Triangles

typedef std::deque<CGAL_Triangle> tympan::CGAL_Triangles

Definition at line 52 of file cgal_tools.h.

◆ CGAL_Vector2

typedef CGAL::Vector_2<CGAL_Gt> tympan::CGAL_Vector2

Definition at line 47 of file cgal_tools.h.

◆ CGAL_Vector3

typedef CGAL::Vector_3<CGAL_Gt> tympan::CGAL_Vector3

Definition at line 48 of file cgal_tools.h.

◆ ComplexSpectrum

typedef OSpectreComplex tympan::ComplexSpectrum

Definition at line 28 of file data_model_common.hpp.

◆ elements_implied_errinfo

typedef boost::error_info< struct tag_elements_implied, std::deque<LPTYElement> > tympan::elements_implied_errinfo

Definition at line 16 of file exceptions.h.

◆ LPSolverConfiguration

typedef boost::shared_ptr< SolverConfiguration > tympan::LPSolverConfiguration

Definition at line 24 of file interfaces.h.

◆ material_pool_t

typedef std::deque<material_ptr_t> tympan::material_pool_t

Definition at line 36 of file entities.hpp.

◆ material_ptr_t

typedef shared_ptr<AcousticMaterialBase> tympan::material_ptr_t

Definition at line 35 of file entities.hpp.

◆ node_idx

typedef size_t tympan::node_idx

Definition at line 31 of file data_model_common.hpp.

◆ nodes_pool_t

typedef std::deque<Point> tympan::nodes_pool_t

Definition at line 30 of file data_model_common.hpp.

◆ oproto_classname_errinfo

typedef boost::error_info< struct tag_classname, std::string > tympan::oproto_classname_errinfo

Definition at line 88 of file TYElement.h.

◆ Point

typedef OPoint3D tympan::Point

Definition at line 25 of file data_model_common.hpp.

◆ position_errinfo

typedef boost::error_info< struct tag_position, OPoint3D > tympan::position_errinfo

Definition at line 18 of file exceptions.h.

◆ receptor_idx

typedef size_t tympan::receptor_idx

Definition at line 353 of file entities.hpp.

◆ receptor_pool_t

typedef std::deque<AcousticReceptor> tympan::receptor_pool_t

Array of receptors.

Definition at line 352 of file entities.hpp.

◆ source_idx

typedef size_t tympan::source_idx

Definition at line 335 of file entities.hpp.

◆ source_pool_t

typedef std::deque<AcousticSource> tympan::source_pool_t

Array of sources.

Definition at line 334 of file entities.hpp.

◆ Spectrum

typedef OSpectre tympan::Spectrum

Definition at line 11 of file spectrum_matrix.h.

◆ triangle_idx

typedef size_t tympan::triangle_idx

Definition at line 157 of file entities.hpp.

◆ triangle_pool_t

typedef std::deque<AcousticTriangle> tympan::triangle_pool_t

Array of AcousticTriangle.

Definition at line 156 of file entities.hpp.

◆ Vector

typedef OVector3D tympan::Vector

Definition at line 26 of file data_model_common.hpp.

Function Documentation

◆ build_box()

std::deque< CGAL_Point3 > tympan::build_box	(	float	w,
		float	h,
		CGAL_Point3	pta,
		CGAL_Point3	ptb
	)

return 4 points defining a 3D parallelepiped

Parameters

w	the width of the parallelepiped
h	the height of the parallelepiped
pta	the center of one of the two faces of dimension w x h
ptb	the center of the other face of dimension w x h

Returns: a deque containing the 4 vertices defining the 3D parallelepiped

Points A and B delimit the length of the parallelepiped and form a segment placed in its center

The vertices of the box that are returned are chosen so that (P1 - P0), (P2 - P0) and (P3 - P0) represent the axes of a non-orthonormal system of reference.

Definition at line 31 of file cgal_tools.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ComputeAcousticCentroid()

Point tympan::ComputeAcousticCentroid ( const source_pool_t & tabSources_ )

Definition at line 1004 of file entities.cpp.

Here is the caller graph for this function:

◆ from_cgal() [1/2]

OPoint3D tympan::from_cgal ( const CGAL_Point3 & cp )

inline

Convert a CGAL_Point3 to OPoint3D.

Definition at line 57 of file cgal_tools.h.

◆ from_cgal() [2/2]

OVector3D tympan::from_cgal ( const CGAL_Vector3 & cp )

inline

Convert a CGAL_Vector3 to OVector3D.

Definition at line 63 of file cgal_tools.h.

◆ init_registry()

void tympan::init_registry ( )

Definition at line 79 of file init_registry.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ intersected_triangles()

std::deque< size_t > tympan::intersected_triangles	(	CGAL_Triangles &	triangle_soup,
		std::deque< CGAL_Point3 >	query_triangle,
		float	l,
		float	w,
		float	h
	)

Find the triangles from triangle_soup that are intersected by the 3D box including the points of query_triangle

Parameters

l	expected length of the 3D box
w	expected width of the 3D box
h	expected height of the 3D box
triangle_soup	triangles whose intersection with query_triangle bounding box will be tested
query_triangle	3 points forming a triangle representing a 3D (bounding) box

The indices of these triangles are returned.

Definition at line 68 of file cgal_tools.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ intersection_report()

void tympan::intersection_report	(	std::deque< size_t > *	intersected,
		CGAL_Triangles::iterator	start_index,
		const CGAL_TBox &	a,
		const CGAL_TBox &	b
	)

Definition at line 54 of file cgal_tools.cpp.

Here is the caller graph for this function:

◆ load_elements()

std::vector< LPTYElement > tympan::load_elements ( const char * filename )

load one or several objects from an xml file

Parameters

filename the file where to save the project

Returns: std::vector<SmartPtr<TYElement>> an array of element that shoud be converted to business elements

Definition at line 72 of file xml_project_util.cpp.

Here is the call graph for this function:

◆ load_project()

LPTYProjet tympan::load_project ( const char * filename )

load an XML project file

Parameters

filename the file containing the project to load project Output argument : this pointer (expected to be NULL) will be made to refer to the loaded TYProjet.

Returns: true if the project could be loader, false otherwise

Definition at line 22 of file xml_project_util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ load_solvers()

void tympan::load_solvers ( const char * path )

Load the solver plugins found in path

Parameters

path	Path to the solver libraries (plugins) to load, containing among others the default solver

Definition at line 300 of file TYPluginManager.cpp.

Here is the call graph for this function:

◆ make_AcousticProblemModel()

std::unique_ptr< AcousticProblemModel > tympan::make_AcousticProblemModel ( )

Definition at line 112 of file acoustic_problem_model.cpp.

◆ make_AcousticResultModel()

std::unique_ptr< AcousticResultModel > tympan::make_AcousticResultModel ( )

Definition at line 19 of file acoustic_result_model.cpp.

Here is the call graph for this function:

◆ make_altimetry_ply_reader()

std::unique_ptr< IMeshReader > tympan::make_altimetry_ply_reader ( const std::string filename )

@ Makes a reader for the file name given as argument

Definition at line 37 of file altimetry_file_reader.cpp.

◆ make_polygon_triangulator()

std::unique_ptr< ITYPolygonTriangulator > tympan::make_polygon_triangulator ( const TYPolygon & poly )

Definition at line 102 of file cgal_bridge.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normalize()

CGAL_Vector3 tympan::normalize ( CGAL_Vector3 v )

normalize vector v

Definition at line 26 of file cgal_tools.cpp.

Here is the caller graph for this function:

◆ save_project()

void tympan::save_project	(	const char *	filename,
		const LPTYProjet &	project
	)

save a project into an XML file

Parameters

filename	the file where to save the project
project	: pointer to the project to save

Returns: true if the project could be saved, false otherwise

Definition at line 55 of file xml_project_util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scene_volume_intersection()

std::deque< triangle_idx > tympan::scene_volume_intersection	(	const triangle_pool_t &	triangles,
		const nodes_pool_t &	nodes,
		float	l,
		float	h,
		OPoint3D	source,
		OPoint3D	receptor
	)

Find the intersection between some triangles (triangles, nodes) and a volume given by a width, a height and 2 points delimiting the length. The volume is centered on the midpoint between the source and the receptor.

Parameters

triangles	List of triangles
nodes	List of nodes
l	Volume length
h	Volume height
source	Acoustic source
receptor	Acoustic receptor

Returns: the indices of the triangles from triangles that are intersected by the volume

Definition at line 21 of file acoustic_problem_model.cpp.

Here is the call graph for this function:

◆ select_solver()

SolverInterface * tympan::select_solver ( OGenID uuid )

Select a solver amongst the loaded solvers (a previous call to tympan::load_solvers() is.

Parameters

uuid	identifier of the solver to load

Definition at line 307 of file TYPluginManager.cpp.

Here is the call graph for this function:

◆ solver_id()

OGenID tympan::solver_id ( std::string name )

Return the id of the solver named name (a previous call to tympan::load_solvers() is.

Definition at line 331 of file TYPluginManager.cpp.

Here is the call graph for this function:

◆ to_cgal() [1/3]

CGAL_Plane tympan::to_cgal ( const OPlan & oplan )

Convert a OPlan to CGAL_Plane.

Definition at line 19 of file cgal_tools.cpp.

Here is the caller graph for this function:

◆ to_cgal() [2/3]

CGAL_Point3 tympan::to_cgal ( const OPoint3D & op )

inline

Convert a OPoint3D to a CGAL_Point3.

Definition at line 60 of file cgal_tools.h.

◆ to_cgal() [3/3]

CGAL_Vector3 tympan::to_cgal ( const OVector3D & op )

inline

Convert a OVector3D to CGAL_Vector3.

Definition at line 66 of file cgal_tools.h.

Here is the call graph for this function:

Classes

Typedefs

Functions

Typedef Documentation

◆ CGAL_Gt

◆ CGAL_K

◆ CGAL_Plane

◆ CGAL_Point2

◆ CGAL_Point3

◆ CGAL_Polygon

◆ CGAL_TBox

◆ CGAL_Transform3

◆ CGAL_Triangle

◆ CGAL_Triangles

◆ CGAL_Vector2

◆ CGAL_Vector3

◆ ComplexSpectrum

◆ elements_implied_errinfo

◆ LPSolverConfiguration

◆ material_pool_t

◆ material_ptr_t

◆ node_idx

◆ nodes_pool_t

◆ oproto_classname_errinfo

◆ Point

◆ position_errinfo

◆ receptor_idx

◆ receptor_pool_t

◆ source_idx

◆ source_pool_t

◆ Spectrum

◆ triangle_idx

◆ triangle_pool_t

◆ Vector

Function Documentation

◆ build_box()

◆ ComputeAcousticCentroid()

◆ from_cgal() [1/2]

◆ from_cgal() [2/2]

◆ init_registry()

◆ intersected_triangles()

◆ intersection_report()

◆ load_elements()

◆ load_project()

◆ load_solvers()

◆ make_AcousticProblemModel()

◆ make_AcousticResultModel()

◆ make_altimetry_ply_reader()

◆ make_polygon_triangulator()

◆ normalize()

◆ save_project()

◆ scene_volume_intersection()

◆ select_solver()

◆ solver_id()

◆ to_cgal() [1/3]

◆ to_cgal() [2/3]

◆ to_cgal() [3/3]