update doc POD, PBCEmbeddingBlock (#256)

Co-authored-by: Dario Coscia <dariocoscia@Dario-Coscia.Home>
2024-03-01 18:30:00 +01:00
parent 22ceee1755
commit 46b366a461
3 changed files with 8 additions and 15 deletions
--- a/docs/source/_rst/_code.rst
+++ b/docs/source/_rst/_code.rst
@@ -68,7 +68,8 @@ Layers
    Spectral convolution <layers/spectral.rst>
    Fourier layers <layers/fourier.rst>
    Continuous convolution <layers/convolution.rst>
-    Coordinates embeddings <layers/embedding.rst>
+    Proper Orthogonal Decomposition <layers/pod.rst>
+    Periodic Boundary Condition embeddings <layers/embedding.rst>
    

 Equations and Operators
--- a/docs/source/_rst/layers/embedding.rst
+++ b/docs/source/_rst/layers/embedding.rst
@@ -1,8 +1,8 @@
-Coordinates embeddings
-======================
+Periodic Boundary Condition embeddings
+=======================================
 .. currentmodule:: pina.model.layers.embedding
    
-.. autoclass:: PBCEmbedding
+.. autoclass:: PeriodicBoundaryEmbedding
    :members:
    :show-inheritance:

--- a/docs/source/_rst/layers/pod.rst
+++ b/docs/source/_rst/layers/pod.rst
@@ -1,15 +1,7 @@
-Spectral Convolution
+PODBlock
 ======================
-.. currentmodule:: pina.model.layers.spectral
+.. currentmodule:: pina.model.layers.pod
    
-.. autoclass:: SpectralConvBlock1D
-    :members:
-    :show-inheritance:
-
-.. autoclass:: SpectralConvBlock2D
-    :members:
-    :show-inheritance:
-
-.. autoclass:: SpectralConvBlock3D
+.. autoclass:: PODBlock
    :members:
    :show-inheritance: