defaults.h

// Copyright 2024, UChicago Argonne, LLC
// All Rights Reserved
// Software Name: NEML2 -- the New Engineering material Model Library, version 2
// By: Argonne National Laboratory
// OPEN SOURCE LICENSE (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
 
#include "neml2/misc/types.h"
 
#define NEML2_TORCH_ENUM(type) k##type
#define NEML2_STRINGIFY(x) #x
#define NEML2_DEFAULT_INTEGER_DTYPE Int64
#define NEML2_DEFAULT_INTEGER_DTYPE_STR NEML2_STRINGIFY(Int64)
#define NEML2_DEFAULT_INTEGER_DTYPE_ENUM NEML2_TORCH_ENUM(Int64)
#define NEML2_DEFAULT_MACHINE_PRECISION 1e-15
#define NEML2_DEFAULT_TOLERANCE 1e-6
#define NEML2_DEFAULT_TIGHTER_TOLERANCE 1e-12
#define NEML2_DEFAULT_BUFFER_NAME_SEPARATOR "_"
#define NEML2_DEFAULT_PARAMETER_NAME_SEPARATOR "_"
 
namespace neml2
{
void set_default_dtype(Dtype dtype);
Dtype get_default_dtype();
TensorOptions default_tensor_options();
TensorOptions default_integer_tensor_options();
Dtype & default_integer_dtype();

Real & machine_precision();
Real & tolerance();
Real & tighter_tolerance();

std::string & buffer_name_separator();
std::string & parameter_name_separator();

bool & require_double_precision();
} // namespace neml2