mast_parameter.cpp

Go to the documentation of this file.

/*
 * MAST: Multidisciplinary-design Adaptation and Sensitivity Toolkit
 * Copyright (C) 2013-2020  Manav Bhatia and MAST authors
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

// Catch2 includes
#include "catch.hpp"

// MAST includes
#include "base/parameter.h"


TEST_CASE("parameters", "[parameter],[base]")
{
    // Create a parameter
    const Real initial_value = 4.984;
    const std::string initial_name = "p1";
    MAST::Parameter parameter1(initial_name, initial_value);
    
    
    SECTION("parameter can return a constant reference to its name")
    {
        const std::string& name = parameter1.name();
        CHECK( name == initial_name );
    }
    
    SECTION("parameter can return a copy of its name")
    {
        std::string name = parameter1.name();
        CHECK( name == initial_name );
        name += "_added_string";
        CHECK( name != initial_name );
        CHECK ( parameter1.name() == initial_name );
    }
    
    SECTION("parameter can return a constant reference to its value")
    {
        const Real const_param_value = parameter1();
        CHECK( const_param_value == initial_value );
    }
    
    SECTION("parameter can return a writable reference to its value")
    {
        Real& parameter_value = parameter1();
        CHECK( parameter_value == initial_value );
    }
    
    SECTION("parameter value can be changed through writable reference to its value")
    {
        Real& parameter_value = parameter1();
        parameter_value = 2.4578;
        CHECK( parameter1() == 2.4578 );
    }
    
    SECTION("parameter value can be set through assignment oeprator '='")
    {
        parameter1 = 5.678;
        CHECK( parameter1() == 5.678 );
    }
    
    SECTION("parameter can return a pointer to its value")
    {
        Real* val_ptr = parameter1.ptr();
        CHECK( *val_ptr == initial_value );
    }
    
    SECTION("parameter depends on itself")
    {
        const bool depends_on_itself = parameter1.depends_on(parameter1);
        CHECK( depends_on_itself );
    }
    
    SECTION("parameter does not depend on other field functions")
    {
        MAST::Parameter parameter2("p2", 5.242);
        const bool depends_on_other = parameter1.depends_on(parameter2);
        CHECK_FALSE( depends_on_other );
    }
    
    SECTION("parameter is NOT a shape parameter by default")
    {
        CHECK_FALSE( parameter1.is_shape_parameter() );
    }
    
    SECTION("parameter can be set as a shape parameter")
    {
        parameter1.set_as_shape_parameter(true);
        CHECK( parameter1.is_shape_parameter() );
    }
    
    SECTION("parameter is NOT a topology parameter by default")
    {
        CHECK_FALSE( parameter1.is_topology_parameter() );
    }
    
    SECTION("parameter can be set as a topology parameter")
    {
        parameter1.set_as_topology_parameter(true);
        CHECK( parameter1.is_topology_parameter() );
    }
    
    //TODO: Test that Parameter constructor accepts a field function as well
}