openfoam/wmake/scripts/have_adios2

#----------------------------------*-sh-*--------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     |
#   \\  /    A nd           | www.openfoam.com
#    \\/     M anipulation  |
#------------------------------------------------------------------------------
#     Copyright (C) 2018-2020 OpenCFD Ltd.
#------------------------------------------------------------------------------
# License
#     This file is part of OpenFOAM, distributed under GPL-3.0-or-later.
#
# Script
#     have_adios2
#
# Description
#     Detection/setup of ADIOS2
#
# Requires
#     ADIOS2_ARCH_PATH
#
# Functions provided
#     have_adios2, no_adios2, echo_adios2, query_adios2, search_adios2
#     hint_adios2
#
# Variables set on success
#     HAVE_ADIOS2
#     ADIOS2_ARCH_PATH
#     ADIOS2_INC_DIR
#     ADIOS2_LIB_DIR
#
#------------------------------------------------------------------------------
. ${WM_PROJECT_DIR:?}/wmake/scripts/sysFunctions    # General system functions

#------------------------------------------------------------------------------

# Reset
no_adios2()
{
    unset HAVE_ADIOS2 ADIOS2_INC_DIR ADIOS2_LIB_DIR
}


# Report
echo_adios2()
{
    echo "adios2=${HAVE_ADIOS2:-false}"
    echo "root=\"$ADIOS2_ARCH_PATH\""
    echo "include=\"$ADIOS2_INC_DIR\""
    echo "library=\"$ADIOS2_LIB_DIR\""
}


# Hint for enabling
hint_adios2()
{
    /bin/cat<<INFORMATION 1>&2
==> adios2 not found?
Define manually, enable in OpenFOAM etc/bashrc, or try the following [POSIX]:

    eval \$(foamEtcFile -sh -config adios2 -- -force)

==
INFORMATION
}


# Search
# $1 : prefix (*_ARCH_PATH, system, ...)
#
# On success, return 0 and export variables
# -> HAVE_ADIOS2, ADIOS2_INC_DIR, ADIOS2_LIB_DIR
search_adios2()
{
    local warn # warn="==> skip adios2"
    local incName="adios2.h"
    local libName="libadios2"
    local libName2="libadios2_cxx11_mpi"

    local prefix="${1:-system}"
    local header library

    # ----------------------------------
    if isNone "$prefix"
    then
        [ -n "$warn" ] && echo "$warn (disabled)"
        return 1
    elif hasAbsdir "$prefix"
    then
        header=$(findFirstFile "$prefix/include/$incName")
        library=$(findExtLib "$libName")
    elif isSystem "$prefix"
    then
        header=$(findSystemInclude -name="$incName")
        prefix=$(sysPrefix "$header")
    else
        unset prefix
    fi
    # ----------------------------------

    # Header
    [ -n "$header" ] || {
        [ -n "$warn" ] && echo "$warn (no header)"
        return 2
    }

    # Library
    [ -n "$library" ] \
    || library=$(findLibrary -prefix="$prefix" -name="$libName") \
    || library=$(findLibrary -prefix="$prefix" -name="$libName2") \
    || {
        [ -n "$warn" ] && echo "$warn (no library)"
        return 2
    }

    # ----------------------------------

    # OK
    export HAVE_ADIOS2=true
    export ADIOS2_ARCH_PATH="$prefix"
    export ADIOS2_INC_DIR="${header%/*}"     # Basename
    export ADIOS2_LIB_DIR="${library%/*}"    # Basename
}


# Output as per search_* function
have_adios2()
{
    local warn # warn="==> skip adios2"
    local config="config.sh/adios2"
    local file

    if file="$("$WM_PROJECT_DIR"/bin/foamEtcFile "$config")"
    then
        . "$file"
    else
        [ -n "$warn" ] && echo "$warn (no $config)"
        return 2
    fi

    search_adios2 "$ADIOS2_ARCH_PATH"
}


# Query settings
query_adios2()
{
    local config="config.sh/adios2"
    local file

    if file="$("$WM_PROJECT_DIR"/bin/foamEtcFile -mode=o "$config")"
    then
        . "$file"
        _process_query adios2 "$ADIOS2_ARCH_PATH"
    else
        echo "(no $config)" 1>&2
        echo "adios2=unknown"
    fi
}


#------------------------------------------------------------------------------

# Reset
no_adios2

# Test/query
case "$1" in
-test)
    have_adios2
    echo_adios2
    ;;
-query)
    query_adios2
    ;;
-hint)
    hint_adios2
    ;;
esac

#------------------------------------------------------------------------------