Arcane::GlobalTimeHistoryAdder Class Reference

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

#include <arcane/core/GlobalTimeHistoryAdder.h>

Inheritance diagram for Arcane::GlobalTimeHistoryAdder:

Collaboration diagram for Arcane::GlobalTimeHistoryAdder:

Public Member Functions
	GlobalTimeHistoryAdder (ITimeHistoryMng *time_history_mng)
	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

Detailed Description

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

This class will record the curves globally, without support. That is, the curves will only be linked to the complete domain or the requested subdomain, unlike MeshTimeHistoryAdder which links the curves to the desired mesh.

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

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

• An "avg_pressure" curve linked to subdomain 0. Each value is the average of the pressures of each cell in subdomain 0.
• An "avg_pressure" curve linked to subdomain 1. Each value is the average of the pressures of each cell in subdomain 1.
• An "avg_pressure" curve linked to the complete domain. Each value is the average of the pressures of each subdomain.

It can be noted that it is possible to have several curves independent ones with the same name but linked to different subdomains (+1 global curve).

Definition at line 54 of file GlobalTimeHistoryAdder.h.

Constructor & Destructor Documentation

GlobalTimeHistoryAdder()

Arcane::GlobalTimeHistoryAdder::GlobalTimeHistoryAdder ( ITimeHistoryMng * time_history_mng )

explicit

Constructor.

Parameters

time_history_mng

A pointer to an instance of ITimeHistoryMng.

Definition at line 26 of file GlobalTimeHistoryAdder.cc.

Member Function Documentation

addValue() [1/6]

void Arcane::GlobalTimeHistoryAdder::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 45 of file GlobalTimeHistoryAdder.cc.

addValue() [2/6]

void Arcane::GlobalTimeHistoryAdder::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 57 of file GlobalTimeHistoryAdder.cc.

addValue() [3/6]

void Arcane::GlobalTimeHistoryAdder::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 39 of file GlobalTimeHistoryAdder.cc.

addValue() [4/6]

void Arcane::GlobalTimeHistoryAdder::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 63 of file GlobalTimeHistoryAdder.cc.

addValue() [5/6]

void Arcane::GlobalTimeHistoryAdder::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 33 of file GlobalTimeHistoryAdder.cc.

addValue() [6/6]

void Arcane::GlobalTimeHistoryAdder::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 51 of file GlobalTimeHistoryAdder.cc.

Member Data Documentation

m_thm

ITimeHistoryMng* Arcane::GlobalTimeHistoryAdder::m_thm

private

Definition at line 78 of file GlobalTimeHistoryAdder.h.

---

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

• GlobalTimeHistoryAdder.h
• GlobalTimeHistoryAdder.cc