fmsio.h

Go to the documentation of this file.

/*
 Copyright (c) 2021, Lawrence Livermore National Security, LLC. Produced at
 the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights
 reserved. See files LICENSE and NOTICE for details.

 This file is part of CEED, a collection of benchmarks, miniapps, software
 libraries and APIs for efficient high-order finite element and spectral
 element discretizations for exascale applications. For more information and
 source code availability see http://github.com/ceed.

 The CEED research is supported by the Exascale Computing Project (17-SC-20-SC)
 a collaborative effort of two U.S. Department of Energy organizations (Office
 of Science and the National Nuclear Security Administration) responsible for
 the planning and preparation of a capable exascale ecosystem, including
 software, applications, hardware, advanced system engineering and early
 testbed platforms, in support of the nation's exascale computing imperative.
*/

/** @file fmsio.h
    FMS file I/O functions.
    Header file added in version: v0.2. */

#ifndef FMS_IO_HEADER
#define FMS_IO_HEADER
#include <fms.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
@brief Writes the provided FmsDataCollection to a file.
@param filename The name of the file to save. If the filename does not include
                an appropriate file extension, one may be added.
@param protocol The type of file to be saved. By default, the protocol should be
                "ascii". If FMS is compiled with Conduit support then the
                protocol can match the supported Conduit protocols, which can
                include: "json", "yaml", "conduit_bin", "hdf5".
@param dc       The FMS object that will be written to the file.
@return The function returns 0 on success and non-zero for failure.
        If Conduit support is enabled then a return value of 2 indicates the
        given protocol is unsupported by the Conduit runtime.

Added in version: v0.2.
*/
int FmsIOWrite(const char *filename, const char *protocol,
               FmsDataCollection dc);

/**
@brief Reads an FmsDataCollection from a file.
@param filename The name of the file to read.
@param protocol The type of file to be read. By default, the protocol should be
                "ascii". If FMS is compiled with Conduit support then the
                protocol can match the supported Conduit protocols, which can
                include: "json", "yaml", "conduit_bin", "hdf5". Adding a
                protocol will help FMS and Conduit decide which method is
                appropriate for reading the file. If Conduit support is enabled
                and protocol is NULL an educated guess will be made for which
                protocol to use.
@param[out] dc  The FMS object that was read from the file.
@return The function returns 0 on success and non-zero for failure.
        If Conduit support is enabled then a return value of 2 indicates the
        given protocol is unsupported by the Conduit runtime.

Added in version: v0.2.
*/
int FmsIORead(const char *filename, const char *protocol,
              FmsDataCollection *dc);


#ifdef __cplusplus
} // extern "C"
#endif

#endif // FMS_IO_HEADER