helicsApps.h

Go to the documentation of this file.

/*
Copyright (c) 2017-2025,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC.  See the top-level NOTICE for
additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
 
#ifndef HELICS_APISHARED_APP_FUNCTIONS_H_
#define HELICS_APISHARED_APP_FUNCTIONS_H_
 
#include "helicsCore.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
HELICS_EXPORT HelicsBool helicsAppEnabled();
HELICS_EXPORT HelicsApp
    helicsCreateApp(const char* appName, const char* appType, const char* configFile, HelicsFederateInfo fedInfo, HelicsError* err);
 
HELICS_EXPORT HelicsFederate helicsAppGetFederate(HelicsApp app, HelicsError* err);
 
HELICS_EXPORT void helicsAppLoadFile(HelicsApp app, const char* configFile, HelicsError* err);
 
HELICS_EXPORT void helicsAppInitialize(HelicsApp app, HelicsError* err);
 
HELICS_EXPORT void helicsAppRun(HelicsApp app, HelicsError* err);
 
HELICS_EXPORT void helicsAppRunTo(HelicsApp app, HelicsTime stopTime, HelicsError* err);
 
HELICS_EXPORT void helicsAppFinalize(HelicsApp app, HelicsError* err);
 
HELICS_EXPORT void helicsAppFree(HelicsApp app);
 
HELICS_EXPORT void helicsAppDestroy(HelicsApp app);
 
HELICS_EXPORT HelicsBool helicsAppIsActive(HelicsApp app);
 
#ifdef __cplusplus
} /* end of extern "C" { */
#endif
 
#endif