Skip to content

Commit

Permalink
Update void fraction with comments
Browse files Browse the repository at this point in the history
  • Loading branch information
blaisb committed Dec 4, 2024
1 parent ee4f467 commit e8745f9
Showing 1 changed file with 10 additions and 21 deletions.
31 changes: 10 additions & 21 deletions include/fem-dem/void_fraction.h
Original file line number Diff line number Diff line change
@@ -1,20 +1,5 @@
/* ---------------------------------------------------------------------
*
* Copyright (C) 2019 - 2024 by the Lethe authors
*
* This file is part of the Lethe library
*
* The Lethe library is free software; you can use it, 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.
* The full text of the license can be found in the file LICENSE at
* the top level of the Lethe distribution.
*
* ---------------------------------------------------------------------
*
*/

// SPDX-FileCopyrightText: Copyright (c) 2021-2024 The Lethe Authors
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later

#ifndef lethe_void_fraction_h
#define lethe_void_fraction_h
Expand Down Expand Up @@ -154,6 +139,8 @@ class VoidFractionBase : public PhysicsLinearSubequationsSolver
/**
* @brief Establishes the constraints of the void fraction systems.
*
* @param boundary_conditions The boundary conditions of fluid dynamics. This is used to establish periodic boundary conditions for the void fraction.
*
*/
void
setup_constraints(
Expand Down Expand Up @@ -208,10 +195,10 @@ class VoidFractionBase : public PhysicsLinearSubequationsSolver


/**
* @brief Initializes the void fraction at the begginig of a simulation
* @brief Initializes the void fraction at the beggining of a simulation
*
* @param time The current time. This is used for time-dependent functions.
*/

void
initialize_void_fraction(const double time)
{
Expand Down Expand Up @@ -280,6 +267,8 @@ class VoidFractionBase : public PhysicsLinearSubequationsSolver
/**
* @brief Solve the linear system resulting from the assemblies
*
* @param is_post_mesh_adaptation Indicates if the equation is being solved during post_mesh_adaptation(),
* for verbosity.
*/
virtual void
solve_linear_system_and_update_solution(
Expand Down Expand Up @@ -369,7 +358,7 @@ class VoidFractionBase : public PhysicsLinearSubequationsSolver
/// void fraction
std::shared_ptr<TrilinosWrappers::PreconditionILU> ilu_preconditioner;

/// System matrix used to assembled the smoothed L2 projection of the void
/// System matrix used to assemble the smoothed L2 projection of the void
/// fraction
TrilinosWrappers::SparseMatrix system_matrix_void_fraction;

Expand All @@ -389,7 +378,7 @@ class VoidFractionBase : public PhysicsLinearSubequationsSolver
/// Offset for the periodic boundary condition
Tensor<1, dim> periodic_offset;

/// Direction associated of the periodic boundary condition
/// Direction associated with the periodic boundary condition
unsigned int periodic_direction;

/// Vertices to periodic cell map, this is used in the QCM and the satellite
Expand Down

0 comments on commit e8745f9

Please sign in to comment.