Skip to content

Commit 4b0b9ee

Browse files
authored
Merge pull request #3639 from farscape-project/minor_fixes
Minor fixes to code comments, docs and placement of preprocessor guards
2 parents 980bf6f + bff934c commit 4b0b9ee

13 files changed

Lines changed: 47 additions & 45 deletions

examples/vector_fe/vector_fe_ex2/laplace_exact_solution.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@
1515
// License along with this library; if not, write to the Free Software
1616
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1717

18+
#ifndef LAPLACE_EXACT_SOLUTION_H
19+
#define LAPLACE_EXACT_SOLUTION_H
20+
1821
#include "libmesh/libmesh_common.h"
1922

2023
using namespace libMesh;
2124

22-
#ifndef LAPLACE_EXACT_SOLUTION_H
23-
#define LAPLACE_EXACT_SOLUTION_H
24-
2525
class LaplaceExactSolution
2626
{
2727
public:

examples/vector_fe/vector_fe_ex2/laplace_system.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
// License along with this library; if not, write to the Free Software
1616
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1717

18+
#ifndef LAPLACE_SYSTEM_H
19+
#define LAPLACE_SYSTEM_H
20+
1821
// DiffSystem framework files
1922
#include "libmesh/fem_system.h"
2023
#include "libmesh/vector_value.h"
@@ -25,9 +28,6 @@
2528

2629
using namespace libMesh;
2730

28-
#ifndef LAPLACE_SYSTEM_H
29-
#define LAPLACE_SYSTEM_H
30-
3131
// FEMSystem, TimeSolver and NewtonSolver will handle most tasks,
3232
// but we must specify element residuals
3333
class LaplaceSystem : public FEMSystem

examples/vector_fe/vector_fe_ex2/solution_function.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
// License along with this library; if not, write to the Free Software
1616
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1717

18+
#ifndef SOLUTION_FUNCTION_H
19+
#define SOLUTION_FUNCTION_H
20+
1821
// libMesh includes
1922
#include "libmesh/function_base.h"
2023

@@ -24,12 +27,8 @@
2427
// C++ includes
2528
#include <memory>
2629

27-
2830
using namespace libMesh;
2931

30-
#ifndef SOLUTION_FUNCTION_H
31-
#define SOLUTION_FUNCTION_H
32-
3332
class SolutionFunction : public FunctionBase<Number>
3433
{
3534
public:

examples/vector_fe/vector_fe_ex3/curl_curl_exact_solution.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@
1515
// License along with this library; if not, write to the Free Software
1616
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1717

18+
#ifndef CURL_CURL_EXACT_SOLUTION_H
19+
#define CURL_CURL_EXACT_SOLUTION_H
20+
1821
#include "libmesh/libmesh_common.h"
1922
#include "libmesh/vector_value.h"
2023

2124
using namespace libMesh;
2225

23-
#ifndef CURL_CURL_EXACT_SOLUTION_H
24-
#define CURL_CURL_EXACT_SOLUTION_H
25-
2626
class CurlCurlExactSolution
2727
{
2828
public:

examples/vector_fe/vector_fe_ex3/curl_curl_system.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
// License along with this library; if not, write to the Free Software
1616
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1717

18+
#ifndef CURL_CURL_SYSTEM_H
19+
#define CURL_CURL_SYSTEM_H
20+
1821
// DiffSystem framework files
1922
#include "libmesh/fem_system.h"
2023
#include "libmesh/vector_value.h"
@@ -25,9 +28,6 @@
2528

2629
using namespace libMesh;
2730

28-
#ifndef CURL_CURL_SYSTEM_H
29-
#define CURL_CURL_SYSTEM_H
30-
3131
/**
3232
* FEMSystem, TimeSolver and NewtonSolver will handle most tasks,
3333
* but we must specify element residuals.

examples/vector_fe/vector_fe_ex3/solution_function.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
// License along with this library; if not, write to the Free Software
1616
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1717

18+
#ifndef SOLUTION_FUNCTION_H
19+
#define SOLUTION_FUNCTION_H
20+
1821
// libMesh includes
1922
#include "libmesh/function_base.h"
2023

@@ -26,9 +29,6 @@
2629

2730
using namespace libMesh;
2831

29-
#ifndef SOLUTION_FUNCTION_H
30-
#define SOLUTION_FUNCTION_H
31-
3232
class SolutionFunction : public FunctionBase<Number>
3333
{
3434
public:

examples/vector_fe/vector_fe_ex4/curl_curl_exact_solution.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@
1515
// License along with this library; if not, write to the Free Software
1616
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1717

18+
#ifndef CURL_CURL_EXACT_SOLUTION_H
19+
#define CURL_CURL_EXACT_SOLUTION_H
20+
1821
#include "libmesh/libmesh_common.h"
1922
#include "libmesh/vector_value.h"
2023

2124
using namespace libMesh;
2225

23-
#ifndef CURL_CURL_EXACT_SOLUTION_H
24-
#define CURL_CURL_EXACT_SOLUTION_H
25-
2626
class CurlCurlExactSolution
2727
{
2828
public:

examples/vector_fe/vector_fe_ex4/curl_curl_system.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
// License along with this library; if not, write to the Free Software
1616
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1717

18+
#ifndef CURL_CURL_SYSTEM_H
19+
#define CURL_CURL_SYSTEM_H
20+
1821
// DiffSystem framework files
1922
#include "libmesh/fem_system.h"
2023
#include "libmesh/vector_value.h"
@@ -25,9 +28,6 @@
2528

2629
using namespace libMesh;
2730

28-
#ifndef CURL_CURL_SYSTEM_H
29-
#define CURL_CURL_SYSTEM_H
30-
3131
// FEMSystem, TimeSolver and NewtonSolver will handle most tasks,
3232
// but we must specify element residuals
3333
class CurlCurlSystem : public FEMSystem

examples/vector_fe/vector_fe_ex4/solution_function.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
// License along with this library; if not, write to the Free Software
1616
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1717

18+
#ifndef SOLUTION_FUNCTION_H
19+
#define SOLUTION_FUNCTION_H
20+
1821
// libMesh includes
1922
#include "libmesh/function_base.h"
2023

@@ -26,9 +29,6 @@
2629

2730
using namespace libMesh;
2831

29-
#ifndef SOLUTION_FUNCTION_H
30-
#define SOLUTION_FUNCTION_H
31-
3232
class SolutionFunction : public FunctionBase<Number>
3333
{
3434
public:

include/base/libmesh_documentation.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@
2323
* - 2, 3, and 4 noded edges (\p Edge2, \p Edge3, \p Edge4).
2424
*
2525
* - Generic 2D Finite Elements
26-
* - 3 and 6 noded triangles (\p Tri3, \p Tri6).
26+
* - 3, 6 and 7 noded triangles (\p Tri3, \p Tri6, \p Tri7).
2727
* - 4, 8, and 9 noded quadrilaterals (\p Quad4, \p Quad8, \p Quad9).
2828
* - 4 and 6 noded infinite quadrilaterals (\p InfQuad4, \p InfQuad6).
2929
*
3030
* - Generic 3D Finite Elements
31-
* - 4 and 10 noded tetrahedra (\p Tet4, \p Tet10).
31+
* - 4, 10 and 14 noded tetrahedra (\p Tet4, \p Tet10, \p Tet14).
3232
* - 8, 20, and 27 noded hexahedra (\p Hex8, \p Hex20, \p Hex27).
3333
* - 6, 15, and 18 noded prisms (\p Prism6, \p Prism15, \p Prism18).
3434
* - 5, 13, and 14 noded pyramids (\p Pyramid5, \p Pyramid13, \p Pyramid14).
@@ -40,7 +40,7 @@
4040
* - Hierarchic
4141
* - C1 elements (Hermite, Clough-Tocher)
4242
* - Discontinuous elements (Monomials, L2-Lagrange)
43-
* - Vector-valued elements (Lagrange-Vec, Nedelec first type)
43+
* - Vector-valued elements (Lagrange-Vec, Monomial-Vec, Nedelec first type)
4444
*
4545
* - Dimension-independence
4646
* - Operators are defined to allow the same code to run unmodified on 2D and 3D applications.

0 commit comments

Comments
 (0)