Arcane::MeshTimeHistoryAdder Class Reference

Class allowing the addition of one or more values to a value history. More...

#include <arcane/core/MeshTimeHistoryAdder.h>

Inheritance diagram for Arcane::MeshTimeHistoryAdder:

Collaboration diagram for Arcane::MeshTimeHistoryAdder:

Public Member Functions
	MeshTimeHistoryAdder (ITimeHistoryMng *time_history_mng, const MeshHandle &mesh_handle)
	Constructor.
void	addValue (const TimeHistoryAddValueArg &thp, Real value) override
	Method allowing the addition of a value to a history.
void	addValue (const TimeHistoryAddValueArg &thp, Int32 value) override
	Method allowing the addition of a value to a history.
void	addValue (const TimeHistoryAddValueArg &thp, Int64 value) override
	Method allowing the addition of a value to a history.
void	addValue (const TimeHistoryAddValueArg &thp, RealConstArrayView values) override
	Method allowing the addition of values to a history.
void	addValue (const TimeHistoryAddValueArg &thp, Int32ConstArrayView values) override
	Method allowing the addition of values to a history.
void	addValue (const TimeHistoryAddValueArg &thp, Int64ConstArrayView values) override
	Method allowing the addition of values to a history.
Public Member Functions inherited from Arcane::ITimeHistoryAdder
virtual	~ITimeHistoryAdder ()=default
	Frees resources.

Private Attributes
ITimeHistoryMng *	m_thm
MeshHandle	m_mesh_handle

Detailed Description

Class allowing the addition of one or more values to a value history.

This class will record curves supported by a mesh. That is, the curves will be linked to a mesh, in addition to being linked to the entire domain or the requested subdomain. If the link to the mesh is not desired, the GlobalTimeHistoryAdder class may be more interesting.

For a given history name, there may be only one curve of a or several values per mesh and per subdomain (and one global one for all subdomains).

Example: several curves of pressure averages (let's call them "avg_pressure"), two subdomains (0 and 1) and two meshes (mesh0 and mesh1). One value per iteration.

• An "avg_pressure" curve linked to subdomain 0 and mesh 0. Each value is the average of the pressures of each cell of mesh 0 and of subdomain 0.
• An "avg_pressure" curve linked to subdomain 0 and mesh 1. Each value is the average of the pressures of each cell of mesh 1 and of subdomain 0.
• An "avg_pressure" curve linked to subdomain 1 and mesh 0. Each value is the average of the pressures of each cell of mesh 0 and of subdomain 1.
• An "avg_pressure" curve linked to subdomain 1 and mesh 1. Each value is the average of the pressures of each cell of mesh 1 and of subdomain 1.
• An "avg_pressure" curve linked to the entire domain and mesh 0. Each value is the average of the pressures of mesh 0 across each subdomain.
• An "avg_pressure" curve linked to the entire domain and mesh 1. Each value is the average of the pressures of mesh 1 across each subdomain.

It can be noted that it is possible to have several independent curves with the same name but linked to different meshes and different subdomains (+1 global curve). It is important to emphasize that this same name can also be used with the curves of GlobalTimeHistoryAdder independently, so the example above can be complementary to the one given in the description of GlobalTimeHistoryAdder! (meaning potentially 9 independent curves but with the same name!)

Definition at line 74 of file MeshTimeHistoryAdder.h.

Constructor & Destructor Documentation

MeshTimeHistoryAdder()

Arcane::MeshTimeHistoryAdder::MeshTimeHistoryAdder	(	ITimeHistoryMng *	time_history_mng,
		const MeshHandle &	mesh_handle )

Constructor.

Parameters

time_history_mng	A pointer to an instance of ITimeHistoryMng.
mesh_handle	The mesh to link to the curves.

Definition at line 26 of file MeshTimeHistoryAdder.cc.

Member Function Documentation

addValue() [1/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg & thp, Int32 value )

overridevirtual

Method allowing the addition of a value to a history.

Parameters

thpi	The parameters of the value.
value	The value to add.

Implements Arcane::ITimeHistoryAdder.

Definition at line 46 of file MeshTimeHistoryAdder.cc.

addValue() [2/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg & thp, Int32ConstArrayView values )

overridevirtual

Method allowing the addition of values to a history.

Parameters

thpi	The parameters of the values.
value	The values to add.

Implements Arcane::ITimeHistoryAdder.

Definition at line 58 of file MeshTimeHistoryAdder.cc.

addValue() [3/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg & thp, Int64 value )

overridevirtual

Method allowing the addition of a value to a history.

Parameters

thpi	The parameters of the value.
value	The value to add.

Implements Arcane::ITimeHistoryAdder.

Definition at line 40 of file MeshTimeHistoryAdder.cc.

addValue() [4/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg & thp, Int64ConstArrayView values )

overridevirtual

Method allowing the addition of values to a history.

Parameters

thpi	The parameters of the values.
value	The values to add.

Implements Arcane::ITimeHistoryAdder.

Definition at line 64 of file MeshTimeHistoryAdder.cc.

addValue() [5/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg & thp, Real value )

overridevirtual

Method allowing the addition of a value to a history.

Parameters

thpi	The parameters of the value.
value	The value to add.

Implements Arcane::ITimeHistoryAdder.

Definition at line 34 of file MeshTimeHistoryAdder.cc.

addValue() [6/6]

void Arcane::MeshTimeHistoryAdder::addValue ( const TimeHistoryAddValueArg & thp, RealConstArrayView values )

overridevirtual

Method allowing the addition of values to a history.

Parameters

thpi	The parameters of the values.
value	The values to add.

Implements Arcane::ITimeHistoryAdder.

Definition at line 52 of file MeshTimeHistoryAdder.cc.

Member Data Documentation

m_mesh_handle

MeshHandle Arcane::MeshTimeHistoryAdder::m_mesh_handle

private

Definition at line 100 of file MeshTimeHistoryAdder.h.

m_thm

ITimeHistoryMng* Arcane::MeshTimeHistoryAdder::m_thm

private

Definition at line 99 of file MeshTimeHistoryAdder.h.

---

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

• MeshTimeHistoryAdder.h
• MeshTimeHistoryAdder.cc