Skip to content

Commit 819442a

Browse files
streevestreeve
authored
Merge pull request #28 from aetx/clang-format
Apply clang format style from Cabana
2 parents fc89254 + 34805d0 commit 819442a

15 files changed

+685
-777
lines changed

‎.clang-format‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
BasedOnStyle: LLVM
2+
---
3+
Language: Cpp
4+
AlwaysBreakTemplateDeclarations: true
5+
BreakBeforeBraces: Allman
6+
BinPackParameters: true
7+
IndentWidth: 4
8+
SpacesInParentheses: true
9+
BreakConstructorInitializersBeforeComma: true
10+
PointerAlignment: Left

‎.github/workflows/CI.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,8 @@ jobs:
4949
cmake -B build -DCMAKE_PREFIX_PATH="$HOME/kokkos;$HOME/Cabana"
5050
cmake --build build --parallel 2
5151
cd build && ctest --output-on-failure
52+
- name: Format
53+
working-directory: build
54+
run: |
55+
make format
56+
git diff --exit-code

‎CMakeLists.txt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,21 @@ if( NOT Cabana_ENABLE_CAJITA )
1616
endif()
1717
find_package(Silo REQUIRED)
1818

19+
# find Clang Format
20+
find_package( CLANG_FORMAT 10 )
21+
1922
# library
2023
add_subdirectory(src)
2124

2225
# examples
2326
add_subdirectory(examples)
27+
28+
##---------------------------------------------------------------------------##
29+
## Clang Format
30+
##---------------------------------------------------------------------------##
31+
if(CLANG_FORMAT_FOUND)
32+
file(GLOB_RECURSE FORMAT_SOURCES src/*.cpp src/*.hpp examples/*.cpp examples/*.hpp)
33+
add_custom_target(format
34+
COMMAND ${CLANG_FORMAT_EXECUTABLE} -i -style=file ${FORMAT_SOURCES}
35+
DEPENDS ${FORMAT_SOURCES})
36+
endif()

‎cmake/FindCLANG_FORMAT.cmake‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
############################################################################
2+
# Copyright (c) 2018-2021 by the Cabana authors #
3+
# All rights reserved. #
4+
# #
5+
# This file is part of the Cabana library. Cabana is distributed under a #
6+
# BSD 3-clause license. For the licensing terms see the LICENSE file in #
7+
# the top-level directory. #
8+
# #
9+
# SPDX-License-Identifier: BSD-3-Clause #
10+
############################################################################
11+
#
12+
# Find clang-format
13+
#
14+
# CLANG_FORMAT_EXECUTABLE - Path to clang-format executable
15+
# CLANG_FORMAT_FOUND - True if the clang-format executable was found.
16+
# CLANG_FORMAT_VERSION - The version of clang-format found
17+
#
18+
19+
find_program(CLANG_FORMAT_EXECUTABLE
20+
NAMES clang-format
21+
clang-format-10
22+
clang-format-9
23+
clang-format-8
24+
clang-format-7
25+
clang-format-6.0
26+
clang-format-5.0
27+
clang-format-4.0
28+
clang-format-3.9
29+
clang-format-3.8
30+
clang-format-3.7
31+
clang-format-3.6
32+
clang-format-3.5
33+
clang-format-3.4
34+
clang-format-3.3
35+
DOC "clang-format executable")
36+
mark_as_advanced(CLANG_FORMAT_EXECUTABLE)
37+
38+
# Extract version from command "clang-format -version"
39+
if(CLANG_FORMAT_EXECUTABLE)
40+
execute_process(COMMAND ${CLANG_FORMAT_EXECUTABLE} -version
41+
OUTPUT_VARIABLE clang_format_version
42+
ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
43+
44+
if(clang_format_version MATCHES "^.*clang-format version .*")
45+
# clang_format_version sample: "clang-format version 3.9.1-4ubuntu3~16.04.1
46+
# (tags/RELEASE_391/rc2)"
47+
string(REGEX
48+
REPLACE "^.*clang-format version ([.0-9]+).*"
49+
"\\1"
50+
CLANG_FORMAT_VERSION
51+
"${clang_format_version}")
52+
# CLANG_FORMAT_VERSION sample: "3.9.1"
53+
else()
54+
set(CLANG_FORMAT_VERSION 0.0)
55+
endif()
56+
else()
57+
set(CLANG_FORMAT_VERSION 0.0)
58+
endif()
59+
60+
include(FindPackageHandleStandardArgs)
61+
# handle the QUIETLY and REQUIRED arguments and set CLANG_FORMAT_FOUND to TRUE
62+
# if all listed variables are TRUE
63+
find_package_handle_standard_args(CLANG_FORMAT REQUIRED_VARS CLANG_FORMAT_EXECUTABLE VERSION_VAR CLANG_FORMAT_VERSION)

‎examples/dam_break.cpp‎

Lines changed: 21 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
#include <ExaMPM_Solver.hpp>
21
#include <ExaMPM_BoundaryConditions.hpp>
2+
#include <ExaMPM_Solver.hpp>
33

44
#include <Cabana_Core.hpp>
55

@@ -20,19 +20,18 @@ struct ParticleInitFunc
2020
double _volume;
2121
double _mass;
2222

23-
ParticleInitFunc( const double cell_size,
24-
const int ppc,
23+
ParticleInitFunc( const double cell_size, const int ppc,
2524
const double density )
2625
: _volume( cell_size * cell_size * cell_size / ppc )
2726
, _mass( _volume * density )
28-
{}
27+
{
28+
}
2929

30-
template<class ParticleType>
31-
KOKKOS_INLINE_FUNCTION
32-
bool operator()( const double x[3], ParticleType& p ) const
30+
template <class ParticleType>
31+
KOKKOS_INLINE_FUNCTION bool operator()( const double x[3],
32+
ParticleType& p ) const
3333
{
34-
if ( 0.0 <= x[0] && x[0] <= 0.4 &&
35-
0.0 <= x[1] && x[1] <= 0.4 &&
34+
if ( 0.0 <= x[0] && x[0] <= 0.4 && 0.0 <= x[1] && x[1] <= 0.4 &&
3635
0.0 <= x[2] && x[2] <= 0.6 )
3736
{
3837
// Affine matrix.
@@ -65,32 +64,29 @@ struct ParticleInitFunc
6564
};
6665

6766
//---------------------------------------------------------------------------//
68-
void damBreak( const double cell_size,
69-
const int ppc,
70-
const int halo_size,
71-
const double delta_t,
72-
const double t_final,
73-
const int write_freq,
67+
void damBreak( const double cell_size, const int ppc, const int halo_size,
68+
const double delta_t, const double t_final, const int write_freq,
7469
const std::string& device )
7570
{
7671
// The dam break domain is in a box on [0,1] in each dimension.
77-
Kokkos::Array<double,6> global_box = { 0.0, 0.0, 0.0, 1.0, 1.0, 1.0 };
72+
Kokkos::Array<double, 6> global_box = { 0.0, 0.0, 0.0, 1.0, 1.0, 1.0 };
7873

7974
// Compute the number of cells in each direction. The user input must
8075
// squarely divide the domain.
81-
std::array<int,3> global_num_cell = { static_cast<int>(1.0 / cell_size),
82-
static_cast<int>(1.0 / cell_size),
83-
static_cast<int>(1.0 / cell_size) };
76+
std::array<int, 3> global_num_cell = {
77+
static_cast<int>( 1.0 / cell_size ),
78+
static_cast<int>( 1.0 / cell_size ),
79+
static_cast<int>( 1.0 / cell_size ) };
8480

8581
// This will look like a 2D problem so make the Y direction periodic.
86-
std::array<bool,3> periodic = { false, false, false };
82+
std::array<bool, 3> periodic = { false, false, false };
8783

8884
// Due to the 2D nature of the problem we will only partition in Y. The
8985
// behavior of the fluid will be to largely just run out in X and Z with
9086
// little movement in Y.
9187
int comm_size;
9288
MPI_Comm_size( MPI_COMM_WORLD, &comm_size );
93-
std::array<int,3> ranks_per_dim = { 1, comm_size, 1 };
89+
std::array<int, 3> ranks_per_dim = { 1, comm_size, 1 };
9490
Cajita::ManualPartitioner partitioner( ranks_per_dim );
9591

9692
// Material properties.
@@ -112,23 +108,10 @@ void damBreak( const double cell_size,
112108
bc.boundary[5] = ExaMPM::BoundaryType::FREE_SLIP;
113109

114110
// Solve the problem.
115-
auto solver =
116-
ExaMPM::createSolver( device,
117-
MPI_COMM_WORLD,
118-
global_box,
119-
global_num_cell,
120-
periodic,
121-
partitioner,
122-
halo_size,
123-
ParticleInitFunc(cell_size,ppc,density),
124-
ppc,
125-
bulk_modulus,
126-
density,
127-
gamma,
128-
kappa,
129-
delta_t,
130-
gravity,
131-
bc );
111+
auto solver = ExaMPM::createSolver(
112+
device, MPI_COMM_WORLD, global_box, global_num_cell, periodic,
113+
partitioner, halo_size, ParticleInitFunc( cell_size, ppc, density ),
114+
ppc, bulk_modulus, density, gamma, kappa, delta_t, gravity, bc );
132115
solver->solve( t_final, write_freq );
133116
}
134117

@@ -168,7 +151,6 @@ int main( int argc, char* argv[] )
168151
MPI_Finalize();
169152

170153
return 0;
171-
172154
}
173155

174156
//---------------------------------------------------------------------------//

‎examples/free_fall.cpp‎

Lines changed: 22 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
#include <ExaMPM_Solver.hpp>
21
#include <ExaMPM_BoundaryConditions.hpp>
2+
#include <ExaMPM_Solver.hpp>
33

44
#include <Cabana_Core.hpp>
55

@@ -20,18 +20,18 @@ struct ParticleInitFunc
2020
double _volume;
2121
double _mass;
2222

23-
ParticleInitFunc( const double cell_size,
24-
const int ppc,
23+
ParticleInitFunc( const double cell_size, const int ppc,
2524
const double density )
26-
: _volume( cell_size * cell_size * cell_size / (ppc*ppc*ppc) )
25+
: _volume( cell_size * cell_size * cell_size / ( ppc * ppc * ppc ) )
2726
, _mass( _volume * density )
28-
{}
27+
{
28+
}
2929

30-
template<class ParticleType>
31-
KOKKOS_INLINE_FUNCTION
32-
bool operator()( const double x[3], ParticleType& p ) const
30+
template <class ParticleType>
31+
KOKKOS_INLINE_FUNCTION bool operator()( const double x[3],
32+
ParticleType& p ) const
3333
{
34-
if ( x[0]*x[0] + x[1]*x[1] + x[2]*x[2] < 0.25 * 0.25 )
34+
if ( x[0] * x[0] + x[1] * x[1] + x[2] * x[2] < 0.25 * 0.25 )
3535
{
3636
// Affine matrix.
3737
for ( int d0 = 0; d0 < 3; ++d0 )
@@ -63,32 +63,29 @@ struct ParticleInitFunc
6363
};
6464

6565
//---------------------------------------------------------------------------//
66-
void freeFall( const double cell_size,
67-
const int ppc,
68-
const int halo_size,
69-
const double delta_t,
70-
const double t_final,
71-
const int write_freq,
66+
void freeFall( const double cell_size, const int ppc, const int halo_size,
67+
const double delta_t, const double t_final, const int write_freq,
7268
const std::string& device )
7369
{
7470
// The dam break domain is in a box on [0,1] in each dimension.
75-
Kokkos::Array<double,6> global_box = { -0.5, -0.5, -0.5, 0.5, 0.5, 0.5 };
71+
Kokkos::Array<double, 6> global_box = { -0.5, -0.5, -0.5, 0.5, 0.5, 0.5 };
7672

7773
// Compute the number of cells in each direction. The user input must
7874
// squarely divide the domain.
79-
std::array<int,3> global_num_cell = { static_cast<int>(1.0 / cell_size),
80-
static_cast<int>(1.0 / cell_size),
81-
static_cast<int>(1.0 / cell_size) };
75+
std::array<int, 3> global_num_cell = {
76+
static_cast<int>( 1.0 / cell_size ),
77+
static_cast<int>( 1.0 / cell_size ),
78+
static_cast<int>( 1.0 / cell_size ) };
8279

8380
// This will look like a 2D problem so make the Y direction periodic.
84-
std::array<bool,3> periodic = { true, true, true };
81+
std::array<bool, 3> periodic = { true, true, true };
8582

8683
// Due to the 2D nature of the problem we will only partition in Y. The
8784
// behavior of the fluid will be to largely just run out in X and Z with
8885
// little movement in Y.
8986
int comm_size;
9087
MPI_Comm_size( MPI_COMM_WORLD, &comm_size );
91-
std::array<int,3> ranks_per_dim = { 1, comm_size, 1 };
88+
std::array<int, 3> ranks_per_dim = { 1, comm_size, 1 };
9289
Cajita::ManualPartitioner partitioner( ranks_per_dim );
9390

9491
// Material properties.
@@ -110,23 +107,10 @@ void freeFall( const double cell_size,
110107
bc.boundary[5] = ExaMPM::BoundaryType::NONE;
111108

112109
// Solve the problem.
113-
auto solver =
114-
ExaMPM::createSolver( device,
115-
MPI_COMM_WORLD,
116-
global_box,
117-
global_num_cell,
118-
periodic,
119-
partitioner,
120-
halo_size,
121-
ParticleInitFunc(cell_size,ppc,density),
122-
ppc,
123-
bulk_modulus,
124-
density,
125-
gamma,
126-
kappa,
127-
delta_t,
128-
gravity,
129-
bc );
110+
auto solver = ExaMPM::createSolver(
111+
device, MPI_COMM_WORLD, global_box, global_num_cell, periodic,
112+
partitioner, halo_size, ParticleInitFunc( cell_size, ppc, density ),
113+
ppc, bulk_modulus, density, gamma, kappa, delta_t, gravity, bc );
130114
solver->solve( t_final, write_freq );
131115
}
132116

@@ -166,7 +150,6 @@ int main( int argc, char* argv[] )
166150
MPI_Finalize();
167151

168152
return 0;
169-
170153
}
171154

172155
//---------------------------------------------------------------------------//

‎src/ExaMPM_BoundaryConditions.hpp‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ struct BoundaryType
3131
struct BoundaryCondition
3232
{
3333
KOKKOS_INLINE_FUNCTION
34-
void operator()( const int gi, const int gj, const int gk,
35-
double& ux, double& uy, double& uz ) const
34+
void operator()( const int gi, const int gj, const int gk, double& ux,
35+
double& uy, double& uz ) const
3636
{
3737
// Low x
3838
if ( gi <= min[0] )
@@ -125,9 +125,9 @@ struct BoundaryCondition
125125
}
126126
}
127127

128-
Kokkos::Array<int,6> boundary;
129-
Kokkos::Array<int,3> min;
130-
Kokkos::Array<int,3> max;
128+
Kokkos::Array<int, 6> boundary;
129+
Kokkos::Array<int, 3> min;
130+
Kokkos::Array<int, 3> max;
131131
};
132132

133133
//---------------------------------------------------------------------------//

0 commit comments

Comments
 (0)