瀏覽代碼

Cleaning up documentation a bit

master
T-bone 6 年之前
父節點
當前提交
b4fb919c1a
共有 3 個檔案被更改,包括 55 行新增44 行删除
  1. 39
    36
      CMakeLists.txt
  2. 15
    0
      EMSchur3D.dox
  3. 1
    8
      include/EMSchur3DBase.h

+ 39
- 36
CMakeLists.txt 查看文件

@@ -5,46 +5,49 @@ set(EMSCHUR3D_VERSION_PATCH "1")
5 5
 set(EMSCHUR3D_VERSION "\"${EMSCHUR3D_VERSION_MAJOR}.${EMSCHUR3D_VERSION_MINOR}.${EMSCHUR3D_VERSION_PATCH}\"")
6 6
 set(EMSCHUR3D_VERSION_NOQUOTES "${EMSCHUR3D_VERSION_MAJOR}.${EMSCHUR3D_VERSION_MINOR}.${EMSCHUR3D_VERSION_PATCH}")
7 7
 
8
-configure_file (
9
-	"${CMAKE_CURRENT_SOURCE_DIR}/config/EMSchur3DConfig.h.in"
10
-	"${PROJECT_BINARY_DIR}/include/EMSchur3DConfig.h"
11
-)
12
-install ( FILES  ${PROJECT_BINARY_DIR}/include/EMSchur3DConfig.h   DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/ )
13
-
14
-add_subdirectory("src")
15
-add_library( emschur3d ${EMSCHUR3DSOURCE} )  
16
-target_include_directories( emschur3d PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/include" )
17
-
18
-set_target_properties(emschur3d PROPERTIES 
19
-	VERSION  "${EMSCHUR3D_VERSION_NOQUOTES}"
20
-	SOVERSION "${EMSCHUR3D_VERSION_MAJOR}.${LEMMA_VERSION_MINOR}"
21
-	PROJECT_LABEL "EMSCHUR3D ${LABEL_SUFFIX}"
22
-    CXX_STANDARD_14
23
-    CXX_STANDARD_REQUIRED_ON
24
-)
25
-
26
-# Linking
27
-target_link_libraries(emschur3d "lemmacore" "fdem1d" )
28
-
29
-# Linking
30 8
 if ( LEMMA_VTK6_SUPPORT OR LEMMA_VTK7_SUPPORT ) 
9
+
10
+	configure_file (
11
+		"${CMAKE_CURRENT_SOURCE_DIR}/config/EMSchur3DConfig.h.in"
12
+		"${PROJECT_BINARY_DIR}/include/EMSchur3DConfig.h"
13
+	)
14
+	install ( FILES  ${PROJECT_BINARY_DIR}/include/EMSchur3DConfig.h   DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/ )
15
+
16
+	add_subdirectory("src")
17
+	add_library( emschur3d ${EMSCHUR3DSOURCE} )  
18
+	target_include_directories( emschur3d PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/include" )
19
+
20
+	set_target_properties(emschur3d PROPERTIES 
21
+		VERSION  "${EMSCHUR3D_VERSION_NOQUOTES}"
22
+		SOVERSION "${EMSCHUR3D_VERSION_MAJOR}.${LEMMA_VERSION_MINOR}"
23
+		PROJECT_LABEL "EMSCHUR3D ${LABEL_SUFFIX}"
24
+    	CXX_STANDARD_14
25
+    	CXX_STANDARD_REQUIRED_ON
26
+	)
27
+
28
+	# Linking
29
+	target_link_libraries(emschur3d "lemmacore" "fdem1d" )
30
+
31
+	# Linking
31 32
 	target_link_libraries(emschur3d ${VTK_LIBRARIES})
32
-endif()
33 33
 
34
-# Testing
35
-if (LEMMA_ENABLE_TESTING)
36
-	add_subdirectory(testing)
37
-endif()
38 34
 
39
-# Install
40
-install ( TARGETS emschur3d DESTINATION ${CMAKE_INSTALL_PREFIX}/lib )
41
-install ( FILES include/EMSchur3D  DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma ) 
42
-install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma  FILES_MATCHING PATTERN "*.h")
35
+	# Testing
36
+	if (LEMMA_ENABLE_TESTING)
37
+		add_subdirectory(testing)
38
+	endif()
39
+
40
+	# Install
41
+	install ( TARGETS emschur3d DESTINATION ${CMAKE_INSTALL_PREFIX}/lib )
42
+	install ( FILES include/EMSchur3D  DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma ) 
43
+	install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma  FILES_MATCHING PATTERN "*.h")
44
+
45
+	#install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/  FILES_MATCHING PATTERN "FDEM1D")
46
+	#install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/FDEM1D  FILES_MATCHING PATTERN "*.h")
43 47
 
44
-#install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/  FILES_MATCHING PATTERN "FDEM1D")
45
-#install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/FDEM1D  FILES_MATCHING PATTERN "*.h")
48
+	# Examples
49
+	if (	LEMMA_BUILD_EXAMPLES)
50
+		add_subdirectory(examples)
51
+	endif()
46 52
 
47
-# Examples
48
-if (LEMMA_BUILD_EXAMPLES)
49
-	add_subdirectory(examples)
50 53
 endif()

+ 15
- 0
EMSchur3D.dox 查看文件

@@ -0,0 +1,15 @@
1
+/**
2
+ * @file
3
+ * @date      09/15/2016 04:28:16 PM
4
+ * @author    Trevor Irons (ti)
5
+ * @email     tirons@egi.utah.edu
6
+ * @copyright Copyright (c) 2016, University of Utah
7
+ * @copyright Copyright (c) 2016, Lemma Software, LLC
8
+ */
9
+
10
+/**
11
+    \defgroup EMSchur3D EMSchur3D
12
+    @brief    Provides 3D solution to Maxwell's equations.
13
+    @details  This is provided using a finite difference scheme.
14
+ */
15
+

+ 1
- 8
include/EMSchur3DBase.h 查看文件

@@ -77,17 +77,10 @@
77 77
 
78 78
 namespace Lemma {
79 79
 
80
-/**
81
- \defgroup EMSchur3DBase EMSchur3DBase
82
-  Provides 3D solution to Maxwell's equations.
83
- */
84
-
85 80
 enum SOLVER{ SPARSELU, SimplicialLLT, SimplicialLDLT, BiCGStab, SparseQR };
86 81
 
87
-
88 82
 /**
89
-  @class EMSchur3DBase
90
-  \ingroup EMSchur3DBase
83
+  \ingroup EMSchur3D
91 84
   \brief Provides a 3D solution to Maxwell's equations.
92 85
   \details 3D finite difference solution to maxwells equations
93 86
             using a SCHUR decomposition on a staggered grid.

Loading…
取消
儲存