Skip to content

Commit 76b1d82

Browse files
committed
Add more API functions
1 parent ea29869 commit 76b1d82

File tree

2 files changed

+101
-3
lines changed

2 files changed

+101
-3
lines changed

docs/source/client_api.rst

Lines changed: 99 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ quickly navigate to each subsection:
1313
- :ref:`client_api_properties` — Functions for creating and closing properties
1414
- :ref:`client_api_containers` — Functions for creating and managing containers
1515
- :ref:`client_api_objects` — Functions for creating and managing objects
16+
- :ref:`client_api_object_tags` — Functions for creating and managing object tags
1617
- :ref:`client_api_regions` — Functions for creating and managing regions
18+
- :ref:`client_api_object_data_transfers` — Functions for object data transfers
1719

1820
.. _client_api_types:
1921

@@ -74,9 +76,21 @@ quickly navigate to each subsection:
7476
.. doxygenfunction:: PDCcont_create
7577
:project: PDC
7678

79+
.. doxygenfunction:: PDCcont_create_col
80+
:project: PDC
81+
82+
.. doxygenfuntion:: PDCcont_open
83+
:project: PDC
84+
85+
.. doxygenfunction:: PDCcont_open_col
86+
:project: PDC
87+
7788
.. doxygenfunction:: PDCcont_close
7889
:project: PDC
7990

91+
.. doxygenfunction:: PDCcont_persist
92+
:project: PDC
93+
8094
.. _client_api_objects:
8195

8296
**5.5.** Objects
@@ -85,19 +99,103 @@ quickly navigate to each subsection:
8599
.. doxygenfunction:: PDCobj_create
86100
:project: PDC
87101

102+
.. doxygenfunction:: PDCobj_create_mpi
103+
:project: PDC
104+
105+
.. doxygenfunction:: PDCobj_open
106+
:project: PDC
107+
108+
.. doxygenfunction:: PDCobj_open_col
109+
:project: PDC
110+
88111
.. doxygenfunction:: PDCobj_close
89112
:project: PDC
90113

114+
.. doxygenfunction:: PDCobj_get_info
115+
:project: PDC
116+
91117
.. doxygenfunction:: PDCprop_obj_dup
92118
:project: PDC
93119

120+
.. doxygenfunction:: PDCprop_set_obj_type
121+
:project: PDC
122+
123+
.. doxygenfunction:: PDCprop_set_obj_dims
124+
:project: PDC
125+
126+
.. doxygenfunction:: PDCprop_set_obj_user_id
127+
:project: PDC
128+
129+
.. doxygenfunction:: PDCprop_set_obj_time_step
130+
:project: PDC
131+
132+
.. doxygenfunction:: PDCprop_set_obj_app_name
133+
:project: PDC
134+
135+
.. doxygenfunction:: PDCprop_set_obj_tags
136+
:project: PDC
137+
138+
.. doxygenfunction:: PDCprop_set_obj_transfer_region_type
139+
:project: PDC
140+
141+
.. doxygenfunction:: PDCobj_iter_start
142+
:project: PDC
143+
144+
.. doxygenfunction:: PDCobj_iter_null
145+
:project: PDC
146+
147+
.. doxygenfunction:: PDCobj_iter_get_info
148+
:project: PDC
149+
150+
.. doxygenfunction:: PDCobj_iter_next
151+
:project: PDC
152+
153+
.. _client_api_object_tags:
154+
155+
**5.6.** Object Tags
156+
--------------------
157+
158+
.. doxygenfunction:: PDCprop_set_obj_tags
159+
:project: PDC
160+
161+
.. doxygenfunction:: PDCobj_put_tag
162+
:project: PDC
163+
164+
.. doxygenfunction:: PDCobj_get_tag
165+
:project: PDC
94166
.. _client_api_regions:
95167

96-
**5.6.** Regions
168+
**5.7.** Regions
97169
----------------
98170

99171
.. doxygenfunction:: PDCregion_create
100172
:project: PDC
101173

102174
.. doxygenfunction:: PDCregion_close
103175
:project: PDC
176+
177+
.. _client_api_object_data_transfers:
178+
179+
**5.8.** Object Data Transfers
180+
------------------------------
181+
182+
.. doxygenfunction:: PDCregion_transfer_start
183+
:project: PDC
184+
185+
.. doxygenfunction:: PDCregion_transfer_wait
186+
:project: PDC
187+
188+
.. doxygenfunction:: PDCregion_transfer_close
189+
:project: PDC
190+
191+
.. doxygenfunction:: PDCregion_transfer_start_all
192+
:project: PDC
193+
194+
.. doxygenfunction:: PDCregion_transfer_wait_all
195+
:project: PDC
196+
197+
.. doxygenfunction:: PDCobj_put_data
198+
:project: PDC
199+
200+
.. doxygenfunction:: PDCobj_get_data
201+
:project: PDC

docs/source/using_pdc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ Regions define logical subranges within a PDC object and are used to specify wha
136136
Transfers can be performed in three main modes:
137137

138138
- Individually, with ``PDCregion_transfer_start()``
139-
- Collectively, with ``PDCregion_transfer_start_col()`` across MPI processes
139+
- Collectively, with ``PDCregion_transfer_start_mpi()`` across MPI processes
140140
- In batches, with ``PDCregion_transfer_start_all()`` and ``PDCregion_transfer_wait_all()``
141141

142142
Basic Region Transfer
@@ -172,7 +172,7 @@ If the transfer is intended to be performed collectively across MPI ranks, use:
172172

173173
.. code-block:: C
174174
175-
PDCregion_transfer_start_col(xfer);
175+
PDCregion_transfer_start_mpi(xfer);
176176
177177
This function should be called by all processes participating in
178178
the transfer and is useful for coordinated I/O in distributed

0 commit comments

Comments
 (0)