GranOO3::DEM::PropUtil Namespace Reference

Enumerations
enum	ResistanceType { THERMAL , ELECTRICAL }
	An enumeration for representing the different kind of resistance. More...

Functions
double	get_local_resistance_between (ResistanceType resType, const DEM::Element &DE1, const DEM::Element &DE2)
	Computes the local resistance between two discrete elements. This resistance can be either thermal or electrical, and depends on the eccentricity of both discrete elements (see the get_eccentricity() method). More...
double	get_eccentricity (const DEM::Element &de)
	this function computes the eccentricity of an element taking into account its neighbor More...
double	get_eccentricity_factor (unsigned int criterion, double eccentricity)
	this function computes the eccentricity factor based on the eccentricity value (computed using get_eccentricity() method) and on a criterion, which should be defined as 0. More...
double	get_surface_transmission (size_t NeighboursCount, double DERadius)
	Computes the transmission surface available for a given discrete element. This surface is used to conduct temperature or electrical current, and depends on the number of neighbours surrounding a given discete elements. Please refer to [1] for more information on the computation method. More...
double	get_volume_fraction (size_t NeighboursCount)
	Similarly to the get_surface_transmission() method, computes the volume fraction of a discrete element surrounded by a given number of neighbours. More...

Enumeration Type Documentation

ResistanceType

enum GranOO3::DEM::PropUtil::ResistanceType

An enumeration for representing the different kind of resistance.

Enumerator
THERMAL	A thermal resistance.
ELECTRICAL	An electrical resistance.

Function Documentation

get_eccentricity()

double GranOO3::DEM::PropUtil::get_eccentricity

(

const DEM::Element &

de

)

this function computes the eccentricity of an element taking into account its neighbor

Parameters

[in]

de

: the central element for computing the eccentricity

Returns

the eccentricity value

This function computes the eccentricity, it is a kind of gravity center of a cluster of element. Eccentricity value can be used for adjusting the electrical conductance for special cases, such as domains boundaries.

get_eccentricity_factor()

double GranOO3::DEM::PropUtil::get_eccentricity_factor	(	unsigned int	criterion,
		double	eccentricity
	)

this function computes the eccentricity factor based on the eccentricity value (computed using get_eccentricity() method) and on a criterion, which should be defined as 0.

Parameters

[in]	criterion	: A value that defines the criterion for evaluating the eccentricity factor (should be 0).
[in]	eccentricity	: The eccentricity value, usually computed from the get_eccentricity() method.

Returns

the eccentricity factor value

get_local_resistance_between()

double GranOO3::DEM::PropUtil::get_local_resistance_between	(	ResistanceType	resType,
		const DEM::Element &	DE1,
		const DEM::Element &	DE2
	)

Computes the local resistance between two discrete elements. This resistance can be either thermal or electrical, and depends on the eccentricity of both discrete elements (see the get_eccentricity() method).

Parameters

[in]	resType	: Resistance type.
[in]	DE1	: First discrete element.
[in]	DE2	: Second discrete element.

Returns

The local resistance between two discrete elements.

get_surface_transmission()

double GranOO3::DEM::PropUtil::get_surface_transmission	(	size_t	NeighboursCount,
		double	DERadius
	)

Computes the transmission surface available for a given discrete element. This surface is used to conduct temperature or electrical current, and depends on the number of neighbours surrounding a given discete elements. Please refer to [1] for more information on the computation method.

Parameters

[in]	NeighboursCount	: The number of neighbours surrounding a given discrete element.
[in]	DERadius	: The radius of a given discrete element.

Returns

The transmission surface.

[1] Hubert, C., André, D., Dubar, L., Iordanoff, I., & Charles, J. L. (2017). Simulation of continuum electrical conduction and Joule heating using DEM domains. International Journal for Numerical Methods in Engineering, 110(9), 862-877.

get_volume_fraction()

double GranOO3::DEM::PropUtil::get_volume_fraction

(

size_t

NeighboursCount

)

Similarly to the get_surface_transmission() method, computes the volume fraction of a discrete element surrounded by a given number of neighbours.

Parameters

[in]

NeighboursCount

: The number of neighbours around a given discrete element.

Returns

The computed volume fraction.