add README, LICENSE.

CMakeLists.txt

@@ -1,12 +1,6 @@
-###############################################################################
+# Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 #
-#  Copyright (c) 2023, Lawrence Livermore National Security, LLC
-#  and other scaleUP SI developers. See the top-level COPYRIGHT
-#  file for details.
-#
-#  SPDX-License-Identifier: (Apache-2.0 OR MIT)
-#
-###############################################################################
+# SPDX-License-Identifier: MIT
 
 # Require CMake version 3.12 or later to expose modern features of
 # CMake for maintainability. With additional work, it is possible to

LICENSE

@@ -1,28 +1,21 @@
-BSD 3-Clause License
+MIT License
 
-Copyright (c) 2023, dreamer2368
+Copyright (c) 2023, Lawrence Livermore National Security, LLC
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+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:
 
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+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.

NOTICE

@@ -0,0 +1,21 @@
+This work was produced under the auspices of the U.S. Department of
+Energy by Lawrence Livermore National Laboratory under Contract
+DE-AC52-07NA27344.
+
+This work was prepared as an account of work sponsored by an agency of
+the United States Government. Neither the United States Government nor
+Lawrence Livermore National Security, LLC, nor any of their employees
+makes any warranty, expressed or implied, or assumes any legal liability
+or responsibility for the accuracy, completeness, or usefulness of any
+information, apparatus, product, or process disclosed, or represents that
+its use would not infringe privately owned rights.
+
+Reference herein to any specific commercial product, process, or service
+by trade name, trademark, manufacturer, or otherwise does not necessarily
+constitute or imply its endorsement, recommendation, or favoring by the
+United States Government or Lawrence Livermore National Security, LLC.
+
+The views and opinions of authors expressed herein do not necessarily
+state or reflect those of the United States Government or Lawrence
+Livermore National Security, LLC, and shall not be used for advertising
+or product endorsement purposes.

README.md

@@ -0,0 +1,48 @@
+<!-- ![libROM Logo](https://www.librom.net/img/logo-300.png) -->
+
+# Introduction
+
+scaleupROM is a projection-based reduced order model (ROM) with discontinuous Galerkin domain decomposition (DG-DD).
+It aims to construct a robust, efficient, large-scale ROM that is trained only from small scale component samples,
+for various physics partial differential equations.
+scaleupROM is mainly built upon [MFEM](https://mfem.org/) and [libROM](https://www.librom.net).
+
+## Features
+
+- Discontinuous Galerkin domain decomposition
+- Projection-based reduced order model
+- EQP for nonlinear partial differential equations
+- Supporting physics equations:
+  - Poisson equation
+  - Stokes flow
+
+## Features to be added
+
+- Steady Navier-Stokes flow
+
+# Installation
+
+**TODO**: set up installation instruction
+
+# Using Docker container
+
+Docker container [`scaleuprom_env`](https://ghcr.io/llnl/scaleuprom/scaleuprom_env) provides a containerized environment with all the prerequisites for scaleupROM:
+- intel chips: [https://ghcr.io/llnl/scaleuprom/scaleuprom_env:latest](https://ghcr.io/llnl/scaleuprom/scaleuprom_env:latest)
+- apple chips: [https://ghcr.io/llnl/scaleuprom/scaleuprom_env:arm64](https://ghcr.io/llnl/scaleuprom/scaleuprom_env:arm64)
+
+# License
+
+scaleupROM is distributed under the MIT license. For more details, see the [LICENSE](https://github.com/LLNL/scaleupROM/blob/master/LICENSE) File.
+
+SPDX-License-Identifier: MIT
+
+LLNL-CODE-857975
+
+# Authors
+- "Kevin" Seung Whan Chung (LLNL)
+- Youngsoo Choi (LLNL)
+- Pratanu Roy (LLNL)
+- Thomas Moore (QUT)
+- Thomas Roy (LLNL)
+- Tiras Y. Lin (LLNL)
+- Sarah E. Baker (LLNL)

include/block_smoother.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef BLOCK_SMOOTHER_HPP
 #define BLOCK_SMOOTHER_HPP

include/component_topology_handler.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef COMPONENT_TOPOLOGY_HANDLER_HPP
 #define COMPONENT_TOPOLOGY_HANDLER_HPP

include/dg_bilinear.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef SCALEUPROM_DG_BILINEAR_HPP
 #define SCALEUPROM_DG_BILINEAR_HPP

include/dg_linear.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef SCALEUPROM_DG_LINEAR_HPP
 #define SCALEUPROM_DG_LINEAR_HPP

include/dg_mixed_bilin.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef SCALEUPROM_DG_MIXED_BILINEAR_HPP
 #define SCALEUPROM_DG_MIXED_BILINEAR_HPP

include/etc.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef ETC_HPP
 #define ETC_HPP

include/hdf5_utils.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef HDF5_UTILS_HPP
 #define HDF5_UTILS_HPP

include/hyperreduction_integ.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef SCALEUPROM_HYPERREDUCTION_INTEG_HPP
 #define SCALEUPROM_HYPERREDUCTION_INTEG_HPP

include/input_parser.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef INPUT_PARSER_HPP
 #define INPUT_PARSER_HPP

include/interfaceinteg.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef SCALEUPROM_INTERFACE_INTEGRATOR_HPP
 #define SCALEUPROM_INTERFACE_INTEGRATOR_HPP

include/linalg_utils.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef LINALG_UTILS_HPP
 #define LINALG_UTILS_HPP

include/main_workflow.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef MAIN_WORKFLOW_HPP
 #define MAIN_WORKFLOW_HPP

include/multiblock_solver.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef SCALEUPROM_MULTIBLOCK_SOLVER_HPP
 #define SCALEUPROM_MULTIBLOCK_SOLVER_HPP

include/navier_solver.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the MFEM library. For more information and source code
-// availability visit https://mfem.org.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef MFEM_NAVIER_SOLVER_HPP
 #define MFEM_NAVIER_SOLVER_HPP

include/nonlinear_integ.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef SCALEUPROM_NONLINEAR_INTEG_HPP
 #define SCALEUPROM_NONLINEAR_INTEG_HPP

include/parameter.hpp

@@ -1,13 +1,6 @@
-// Copyright (c) 2010-2022, Lawrence Livermore National Security, LLC. Produced
-// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
-// LICENSE and NOTICE for details. LLNL-CODE-806117.
+// Copyright 2023 Lawrence Livermore National Security, LLC. See the top-level LICENSE file for details.
 //
-// This file is part of the scaleupROM library. For more information and source code
-// availability visit https://lc.llnl.gov/gitlab/chung28/scaleupROM.git.
-//
-// MFEM is free software; you can redistribute it and/or modify it under the
-// terms of the BSD-3 license. We welcome feedback and contributions, see file
-// CONTRIBUTING.md for details.
+// SPDX-License-Identifier: MIT
 
 #ifndef PARAMETER_HPP
 #define PARAMETER_HPP