ICoCo::ProblemTrio

ICoCo::ProblemTrio#

#include <ProblemTrio.h>

class ProblemTrio

How to cite this class in this doc#

RST

:ref:`ICoCo::ProblemTrio <class-icoco-problemtrio>`

Markdown

[ICoCo::ProblemTrio](#class-icoco-problemtrio)

Detailed description#

This class defines the API a problem has to implement in order to be coupled. For precise specifications and possible use of this API, See NT SSTH/LMDL_2006_001 Implements IterativeUnsteadyProblem and FieldIO

Inherits from#

public : Problem

Complete Member Function Documentation#

abortTimeStep

void ProblemTrio::abortTimeStep() override

Aborts the resolution of the current time step.

computeTimeStep

double ProblemTrio::computeTimeStep(bool &stop) const override

Compute the value the Problem would like for the next time step.

This value will not necessarily be used at the call of initTimeStep, but it is a hint. This method may use all the internal state of the Problem.

getDirectAccessToUnknown

ICoCo::MEDDoubleField ProblemTrio::getDirectAccessToUnknown(const std::string &unk_name, bool isFuture)

getFieldType

ICoCo::ValueType ProblemTrio::getFieldType(const std::string &name) const override

getInputFieldsNames

vector<string> ProblemTrio::getInputFieldsNames() const override

This method is used to find the names of input fields understood by the Problem.

getInputFieldTemplate

void ProblemTrio::getInputFieldTemplate(const std::string &name, TrioField &afield) const override

This method is used to get a template of a field expected for the given name.

getInputMEDDoubleFieldTemplate

void ProblemTrio::getInputMEDDoubleFieldTemplate(const std::string &name, MEDDoubleField &afield) const override

getMEDCouplingMajorVersion

int ProblemTrio::getMEDCouplingMajorVersion() const override

getOutputDoubleValue

double ProblemTrio::getOutputDoubleValue(const std::string &name) const override

getOutputField

void ProblemTrio::getOutputField(const std::string &name, TrioField &afield) const override

getOutputFieldsNames

vector<string> ProblemTrio::getOutputFieldsNames() const override

getOutputIntValue

int ProblemTrio::getOutputIntValue(const std::string &name) const override

getOutputMEDDoubleField

void ProblemTrio::getOutputMEDDoubleField(const std::string &name, MEDDoubleField &afield) const override

getOutputStringValue

std::string ProblemTrio::getOutputStringValue(const std::string &name) const override

getStationaryMode

bool ProblemTrio::getStationaryMode() const override

initialize

bool ProblemTrio::initialize() override

This method is called once at the beginning, before any other one of the interface Problem.

initialize_pb

bool ProblemTrio::initialize_pb(Probleme_U &pb)

initTimeStep

bool ProblemTrio::initTimeStep(double dt) override

This method allocates and initializes the unknown and given fields for the future time step.

The value of the interval is imposed through the parameter dt. In case of error, returns false.

isMEDCoupling64Bits

bool ProblemTrio::isMEDCoupling64Bits() const override

isStationary

bool ProblemTrio::isStationary() const override

Tells if the Problem unknowns have changed during the last time step.

iterateTimeStep

bool ProblemTrio::iterateTimeStep(bool &converged) override

In the case solveTimeStep uses an iterative process, this method executes a single iteration.

It is thus possible to modify the given fields between iterations. converged is set to true if the process has converged, ie if the unknown fields are solution to the problem on the next time step. Otherwise converged is set to false. The return value indicates if the convergence process behaves normally. If false, the ProblemTrio wishes to abort the time step resolution.

presentTime

double ProblemTrio::presentTime() const override

Returns the present time.

This value may change only at the call of validateTimeStep. A surcharger

ProblemTrio

ProblemTrio::ProblemTrio()

As initialize doesn’t have any arguments, they can be passed to the Problem at the time of instantiation.

They can include data file name, MPI communicator,.. In this implementation (for use outside TRUST), only the name of an underlying Probleme_U needs to be provided.

resetTime

void ProblemTrio::resetTime(double time) override

Reset the current time of the Problem to a given value.

New in version 2 of ICoCo . Particularly useful for the initialization of complex transients: the starting point of the transient of interest is computed first, the time is reset to 0, and then the actual transient of interest starts with proper initial conditions, and global time 0. Can be called outside the TIME_STEP_DEFINED context (see Problem documentation).

setDataFile

void ProblemTrio::setDataFile(const std::string &datafile) override

setInputDoubleValue

void ProblemTrio::setInputDoubleValue(const std::string &name, const double &val) override

setInputField

void ProblemTrio::setInputField(const std::string &name, const TrioField &afield) override

This method is used to provide the Problem with an input field.

setInputIntValue

void ProblemTrio::setInputIntValue(const std::string &name, const int &val) override

setInputMEDDoubleField

void ProblemTrio::setInputMEDDoubleField(const std::string &name, const MEDDoubleField &afield) override

setInputStringValue

void ProblemTrio::setInputStringValue(const std::string &name, const std::string &val) override

setMPIComm

void ProblemTrio::setMPIComm(void *) override

setStationaryMode

void ProblemTrio::setStationaryMode(bool stationary) override

solveTimeStep

bool ProblemTrio::solveTimeStep() override

Calculates the unknown fields for the next time step.

The default implementation uses iterations.

terminate

void ProblemTrio::terminate() override

This method is called once at the end, after any other one.

It frees the memory and saves anything that needs to be saved.

updateOutputField

void ProblemTrio::updateOutputField(const std::string &name, TrioField &afield) const override

updateOutputMEDDoubleField

void ProblemTrio::updateOutputMEDDoubleField(const std::string &name, MEDDoubleField &afield) const override

validateTimeStep

void ProblemTrio::validateTimeStep() override

Validates the calculated unknown by moving the present time at the end of the time step.

This method is allowed to free past values of the unknown and given fields.

~ProblemTrio

ProblemTrio::~ProblemTrio() override

Attributes Documentation#

my_params (protected)

Init_Params* ICoCo::ProblemTrio::my_params

p (protected)

mon_main* ICoCo::ProblemTrio::p

pb (protected)

Probleme_U* ICoCo::ProblemTrio::pb