Interface Functions

Functions
virtual bool	geos::FieldStatisticsBase< SOLVER >::execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override=0
	Main extension point of executable targets. More...
virtual bool	geos::CompositionalMultiphaseStatistics::execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
	Main extension point of executable targets. More...
virtual bool	geos::SinglePhaseStatistics::execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
	Main extension point of executable targets. More...
virtual bool	geos::StencilDataCollection::execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
	Main extension point of executable targets. More...
virtual bool	geos::PoromechanicsInitialization< POROMECHANICS_SOLVER >::execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
	Main extension point of executable targets. More...
virtual bool	geos::SolidMechanicsStateReset::execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
	Main extension point of executable targets. More...
virtual bool	geos::SolidMechanicsStatistics::execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
	Main extension point of executable targets. More...

Detailed Description

This function implements the interface defined by the abstract TaskBase class

Function Documentation

execute() [1/7]

virtual bool geos::CompositionalMultiphaseStatistics::execute ( real64 const  time_n, real64 const  dt, integer const  cycleNumber, integer const  eventCounter, real64 const  eventProgress, DomainPartition &  domain  )

overridevirtual

Main extension point of executable targets.

Parameters

[in]	time_n	current time level
[in]	dt	time step to be taken
[in]	cycleNumber	global cycle number
[in]	eventCounter	index of event that triggered execution
[in]	eventProgress	fractional progress in current cycle
[in,out]	domain	the physical domain up-casted to a Group.

Returns

True iff this event requires exiting the event loop.

If the start criteria are satisfied, then the event manager will call this method.

Implements geos::FieldStatisticsBase< CompositionalMultiphaseBase >.

execute() [2/7]

virtual bool geos::SinglePhaseStatistics::execute ( real64 const  time_n, real64 const  dt, integer const  cycleNumber, integer const  eventCounter, real64 const  eventProgress, DomainPartition &  domain  )

overridevirtual

Main extension point of executable targets.

Parameters

[in]	time_n	current time level
[in]	dt	time step to be taken
[in]	cycleNumber	global cycle number
[in]	eventCounter	index of event that triggered execution
[in]	eventProgress	fractional progress in current cycle
[in,out]	domain	the physical domain up-casted to a Group.

Returns

True iff this event requires exiting the event loop.

If the start criteria are satisfied, then the event manager will call this method.

Implements geos::FieldStatisticsBase< SinglePhaseBase >.

execute() [3/7]

virtual bool geos::StencilDataCollection::execute ( real64 const  time_n, real64 const  dt, integer const  cycleNumber, integer const  eventCounter, real64 const  eventProgress, DomainPartition &  domain  )

overridevirtual

Main extension point of executable targets.

Parameters

[in]	time_n	current time level
[in]	dt	time step to be taken
[in]	cycleNumber	global cycle number
[in]	eventCounter	index of event that triggered execution
[in]	eventProgress	fractional progress in current cycle
[in,out]	domain	the physical domain up-casted to a Group.

Returns

True iff this event requires exiting the event loop.

If the start criteria are satisfied, then the event manager will call this method.

Reimplemented from geos::TaskBase.

execute() [4/7]

template<typename POROMECHANICS_SOLVER >

virtual bool geos::PoromechanicsInitialization< POROMECHANICS_SOLVER >::execute ( real64 const  time_n, real64 const  dt, integer const  cycleNumber, integer const  eventCounter, real64 const  eventProgress, DomainPartition &  domain  )

overridevirtual

Main extension point of executable targets.

Parameters

[in]	time_n	current time level
[in]	dt	time step to be taken
[in]	cycleNumber	global cycle number
[in]	eventCounter	index of event that triggered execution
[in]	eventProgress	fractional progress in current cycle
[in,out]	domain	the physical domain up-casted to a Group.

Returns

True iff this event requires exiting the event loop.

If the start criteria are satisfied, then the event manager will call this method.

Reimplemented from geos::TaskBase.

execute() [5/7]

virtual bool geos::SolidMechanicsStateReset::execute ( real64 const  time_n, real64 const  dt, integer const  cycleNumber, integer const  eventCounter, real64 const  eventProgress, DomainPartition &  domain  )

overridevirtual

Main extension point of executable targets.

Parameters

[in]	time_n	current time level
[in]	dt	time step to be taken
[in]	cycleNumber	global cycle number
[in]	eventCounter	index of event that triggered execution
[in]	eventProgress	fractional progress in current cycle
[in,out]	domain	the physical domain up-casted to a Group.

Returns

True iff this event requires exiting the event loop.

If the start criteria are satisfied, then the event manager will call this method.

Reimplemented from geos::TaskBase.

execute() [6/7]

virtual bool geos::SolidMechanicsStatistics::execute ( real64 const  time_n, real64 const  dt, integer const  cycleNumber, integer const  eventCounter, real64 const  eventProgress, DomainPartition &  domain  )

overridevirtual

Main extension point of executable targets.

Parameters

[in]	time_n	current time level
[in]	dt	time step to be taken
[in]	cycleNumber	global cycle number
[in]	eventCounter	index of event that triggered execution
[in]	eventProgress	fractional progress in current cycle
[in,out]	domain	the physical domain up-casted to a Group.

Returns

True iff this event requires exiting the event loop.

If the start criteria are satisfied, then the event manager will call this method.

Implements geos::FieldStatisticsBase< SolidMechanicsLagrangianFEM >.

execute() [7/7]

template<typename SOLVER >

virtual bool geos::FieldStatisticsBase< SOLVER >::execute ( real64 const  time_n, real64 const  dt, integer const  cycleNumber, integer const  eventCounter, real64 const  eventProgress, DomainPartition &  domain  )

overridepure virtual

Main extension point of executable targets.

Parameters

[in]	time_n	current time level
[in]	dt	time step to be taken
[in]	cycleNumber	global cycle number
[in]	eventCounter	index of event that triggered execution
[in]	eventProgress	fractional progress in current cycle
[in,out]	domain	the physical domain up-casted to a Group.

Returns

True iff this event requires exiting the event loop.

If the start criteria are satisfied, then the event manager will call this method.

Reimplemented from geos::TaskBase.

Implemented in geos::SolidMechanicsStatistics, geos::SourceFluxStatsAggregator, geos::SinglePhaseStatistics, and geos::CompositionalMultiphaseStatistics.