GIDI_regions2d.cc

Go to the documentation of this file.

/*
# <<BEGIN-copyright>>
# Copyright 2019, Lawrence Livermore National Security, LLC.
# This file is part of the gidiplus package (https://github.com/LLNL/gidiplus).
# gidiplus is licensed under the MIT license (see https://opensource.org/licenses/MIT).
# SPDX-License-Identifier: MIT
# <<END-copyright>>
*/
 
#include "GIDI.hpp"
#include <HAPI.hpp>
 
namespace GIDI {
 
namespace Functions {
 
/*! \class Regions2d
 * Class for the GNDS <**regions2d**> node.
 */
 
/* *********************************************************************************************************//**
 *
 * @param a_construction    [in]    Used to pass user options to the constructor.
 * @param a_node            [in]    The **HAPI::Node** to be parsed and used to construct the XYs2d.
 * @param a_setupInfo       [in]    Information create my the Protare constructor to help in parsing.
 * @param a_parent          [in]    The parent GIDI::Suite.
 ***********************************************************************************************************/
 
Regions2d::Regions2d( Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, Suite *a_parent ) :
        Function2dForm( a_construction, a_node, a_setupInfo, FormType::regions2d, a_parent ) {
 
    if( a_setupInfo.m_formatVersion.format( ) != GNDS_formatVersion_1_10Chars ) {
        data2dListParse( a_construction, a_node.child( GIDI_function2dsChars ), a_setupInfo, m_function2ds );
        checkSequentialDomainLimits2d( m_function2ds, m_Xs );
        return;                                     // Need to add uncertainty parsing.
    }
 
    for( HAPI::Node child = a_node.first_child( ); !child.empty( ); child.to_next_sibling( ) ) {
        std::string name( child.name( ) );
 
        if( name == GIDI_axesChars ) continue;
        if( name == GIDI_uncertaintyChars ) continue;
 
        Function2dForm *_form = data2dParse( a_construction, child, a_setupInfo, nullptr );
        if( _form == nullptr ) throw Exception( "Regions2d::Regions2d: data2dParse returned nullptr." );
        append( _form );
    }
}
 
/* *********************************************************************************************************//**
 ***********************************************************************************************************/
 
Regions2d::~Regions2d( ) {
 
    for( std::vector<Function2dForm *>::iterator iter = m_function2ds.begin( ); iter < m_function2ds.end( ); ++iter ) delete *iter;
}
 
/* *********************************************************************************************************//**
 * Returns the domain minimum for the instance.
 *
 * @return          The domain minimum for the instance.
 ***********************************************************************************************************/
 
double Regions2d::domainMin( ) const {
 
    if( m_Xs.size( ) == 0 ) throw Exception( "Regions2d::domainMin: Regions2d has no regions" );
    return( m_Xs[0] );
}
 
/* *********************************************************************************************************//**
 * Returns the domain maximum for the instance.
 *
 * @return              The domain maximum for the instance.
 ***********************************************************************************************************/
 
double Regions2d::domainMax( ) const {
 
    if( m_Xs.size( ) == 0 ) throw Exception( "Regions2d::domainMax: Regions2d has no regions" );
    return( m_Xs[m_Xs.size( )-1] );
}
 
/* *********************************************************************************************************//**
 * Appends the 2d function *a_function* to the region.
 *
 ***********************************************************************************************************/
 
void Regions2d::append( Function2dForm *a_function ) {
 
    if( dimension( ) != a_function->dimension( ) ) throw Exception( "Regions2d::append: dimensions differ." );
 
    double _domainMin = a_function->domainMin( ), _domainMax = a_function->domainMax( );
 
    if( m_Xs.size( ) == 0 ) {
        m_Xs.push_back( _domainMin ); }
    else {
        if( m_Xs.back( ) != _domainMin ) throw Exception( "Regions2d::append: regions do not abut." );
    }
 
    m_Xs.push_back( _domainMax );
    m_function2ds.push_back( a_function );
}
 
/* *********************************************************************************************************//**
 * The value of *y(x2,x1)* at the point *a_x2*, *a_x1*.
 *
 * @param a_x2          [in]    The point for the *x2* axis.
 * @param a_x1          [in]    The point for the *x1* axis.
 * @return                      The value of the function at the point *a_x2*, *a_x1*.
 ***********************************************************************************************************/
 
double Regions2d::evaluate( double a_x2, double a_x1 ) const {
 
    if( m_Xs.size( ) == 0 ) throw Exception( "Regions2d::evaluate: regions2d has no regions" );
 
    long iX1 = binarySearchVector( a_x1, m_Xs );
 
    if( iX1 < 0 ) {
        if( iX1 == -1 ) {       /* x1 > last value of Xs. */
            return( m_function2ds.back( )->evaluate( a_x2, a_x1 ) );
        }
        iX1 = 0;                /* x1 < last value of Xs. */
    }
 
    return( m_function2ds[static_cast<std::size_t>(iX1)]->evaluate( a_x2, a_x1 ) );
}
 
/* *********************************************************************************************************//**
 * Fills the argument *a_writeInfo* with the XML lines that represent *this*. Recursively enters each sub-node.
 * 
 * @param       a_writeInfo         [in/out]    Instance containing incremental indentation and other information and stores the appended lines.
 * @param       a_indent            [in]        The amount to indent *this* node.
 * @param       a_embedded          [in]        If *true*, *this* function is embedded in a higher dimensional function.
 * @param       a_inRegions         [in]        If *true*, *this* is in a Regions2d container.
 ***********************************************************************************************************/
 
void Regions2d::toXMLList_func( GUPI::WriteInfo &a_writeInfo, std::string const &a_indent, bool a_embedded, bool a_inRegions ) const {
 
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
    std::string attributes;
 
    if( a_embedded ) {
        attributes += a_writeInfo.addAttribute( GIDI_outerDomainValueChars, LUPI::Misc::doubleToShortestString( outerDomainValue( ) ) ); }
    else {
        if( a_inRegions ) {
            attributes = a_writeInfo.addAttribute( GIDI_indexChars, intToString( index( ) ) ); }
        else {
            if( label( ) != "" ) attributes = a_writeInfo.addAttribute( GIDI_labelChars, label( ) );
        }
    }
 
    a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
    axes( ).toXMLList( a_writeInfo, indent2 ); 
    for( std::vector<Function2dForm *>::const_iterator iter = m_function2ds.begin( ); iter != m_function2ds.end( ); ++iter ) (*iter)->toXMLList_func( a_writeInfo, indent2, false, true );
    a_writeInfo.addNodeEnder( moniker( ) );
}
 
}               // End namespace Functions.
 
}               // End namespace GIDI.