MGIS 3.1.0
Loading...
Searching...
No Matches
mgis::behaviour::debug::BehaviourIntegrationFailureAnalyser Struct Referenceabstract

object in charge of analysing and integration failure. This object is used by the integrate_debug function More...

#include </home/runner/work/MFrontGenericInterfaceSupport/MFrontGenericInterfaceSupport/include/MGIS/Behaviour/BehaviourIntegrationFailureAnalyser.hxx>

Public Member Functions

virtual void analyse (const Behaviour &, const BehaviourData &) const MGIS_NOEXCEPT=0
 handle an integration failure
virtual void analyse (const Behaviour &, const BehaviourDataView &) const MGIS_NOEXCEPT=0
 handle an integration failure
virtual bool shallCopyBehaviourDataBeforeIntegration () const MGIS_NOEXCEPT=0
 use a copy of the inputs
virtual ~BehaviourIntegrationFailureAnalyser () noexcept
 destructor

Detailed Description

object in charge of analysing and integration failure. This object is used by the integrate_debug function

Note
most analysers generate a file. See the getBehaviourIntegrationFailureAnalysisFileName below for a way to generate a unique file name. By default, this file name is unique for the given process. In an MPI context, one shall provide a file name generator which takes the MPI process id into account to avoid conflicts, see the function setBehaviourIntegrationFailureAnalysisFileNameGenerator for details.

Member Function Documentation

◆ analyse() [1/2]

virtual void mgis::behaviour::debug::BehaviourIntegrationFailureAnalyser::analyse ( const Behaviour & ,
const BehaviourData &  ) const
pure virtual

handle an integration failure

Parameters
[in]bbehaviour being integrated
[in]dbehaviour data leading to the integration failure

◆ analyse() [2/2]

virtual void mgis::behaviour::debug::BehaviourIntegrationFailureAnalyser::analyse ( const Behaviour & ,
const BehaviourDataView &  ) const
pure virtual

handle an integration failure

Parameters
[in]bbehaviour being integrated
[in]dbehaviour data view leading to the integration failure

◆ shallCopyBehaviourDataBeforeIntegration()

virtual bool mgis::behaviour::debug::BehaviourIntegrationFailureAnalyser::shallCopyBehaviourDataBeforeIntegration ( ) const
nodiscardpure virtual

use a copy of the inputs

If true, the behaviour data view passed to the integrate_debug function is copied before integrating the behaviour. Copying has a significant overhead and is normally not required for correctly written behaviours but data corruption may occur, so copying is safer.


The documentation for this struct was generated from the following file: