Doubt in collect_periodic_faces() documentation

[vachanpo...@gmail.com]

Hi all,

The documentation of collect_periodic_faces() reads

Instead of defining a 'first' and 'second' boundary with the help of two boundary_ids this function defines a 'left' boundary as all faces with local face index 2*dimension and boundary indicator b_id and, similarly, a 'right' boundary consisting of all face with local face index 2*dimension+1 and boundary indicator b_id. Faces with coordinates only differing in the direction component are identified.

I am confused as to what could 'dimension' mean here. Neither the template, nor the arguments have any variable called dimension. For dimension=3, this would mean faces with local ids 6 and 7 would be looked for. They don't exist right??

I was wondering if this is a typo and 'dimension' should actually be 'direction'. Any clarification would be greatly helpful.

Thanking in anticipation

Vachan

[Daniel Arndt]

Vachan,

`dimension` is understood in the sense of dimension in which to apply periodicity:

x-direction (0) means identifying faces with id 0 and 1,

y-direction (1) means identifying faces with id 2 and 3,

z-direction (2) means identifying faces with id 4 and 5,

Best,

Daniel

--
The deal.II project is located at http://www.dealii.org/
For mailing list/forum options, see https://groups.google.com/d/forum/dealii?hl=en
---
You received this message because you are subscribed to the Google Groups "deal.II User Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dealii+un...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/dealii/fd8c68f2-71f2-4df4-9684-ad7058ac5a54n%40googlegroups.com.

[vachanpo...@gmail.com]

Dr. Arndt,

Thank you for the clarification. But then isn't dimension redundant here? If I understand correctly, using direction would also give the same face indices. How are direction and dimension different here?

[Daniel Arndt]

Vachan,

"dimension" actually doesn't appear in the function signature at all so it seems reasonable to just replace it with "direction" in its documentation.

Best,

Daniel

To view this discussion on the web visit https://groups.google.com/d/msgid/dealii/09436f9e-48a5-4a5d-b93e-36b199973b7en%40googlegroups.com.

[Wolfgang Bangerth]

On 3/29/21 6:04 PM, Daniel Arndt wrote:
>
> "dimension" actually doesn't appear in the function signature at all so it
> seems reasonable to just replace it with "direction" in its documentation.

Vachan,
I think you now understand what the documentation *wants* to say. Would you
like to write a patch to make it clearer? We always appreciate patches to the
documentation!

Best
W.


--
------------------------------------------------------------------------
Wolfgang Bangerth email: bang...@colostate.edu
www: http://www.math.colostate.edu/~bangerth/

[vachanpo...@gmail.com]

Prof. Bangerth

I would like to. However, I do not know how to write patches. Nor have I any experience with using github collaboratively; I have only used it for my personal repos. I would love to contribute if the experts can provide a little guidance.

I have also noticed a small mistake in the param doc of subdivided_hyper_cube(). I would like to submit a patch for that too. I have never seen a library documented so well (in the few years since I started doing CFD). I wish it stays so and would love to contribute in making its doc better.

Thanks

[Wolfgang Bangerth]

On 3/30/21 11:20 AM, vachanpo...@gmail.com wrote:
>
> I would like to. However, I do not know how to write patches. Nor have I any
> experience with using github collaboratively; I have only used it for my
> personal repos. I would love to contribute if the experts can provide a little
> guidance.
>
> I have also noticed a small mistake in the param doc of
> subdivided_hyper_cube()

> <https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.dealii.org%2Fcurrent%2Fdoxygen%2Fdeal.II%2FnamespaceGridGenerator.html%23a358d5bd545bc115c8645d93fa79b64bc&data=04%7C01%7CWolfgang.Bangerth%40colostate.edu%7Cc1739b044b524c15c2f808d8f35d071e%7Cafb58802ff7a4bb1ab21367ff2ecfc8b%7C0%7C0%7C637526928168313637%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=uAAw8MKKMbiVIURPjBnCPpB%2BwE34%2FzaotaftlTT8xgU%3D&reserved=0>.

> I would like to submit a patch for that too. I have never seen a library
> documented so well (in the few years since I started doing CFD). I wish it
> stays so and would love to contribute in making its doc better.

Vachan,
we would certainly love to have those patches! We wrote up some instructions
on how to contribute here:
https://dealii.org/participate.html
Does this help? If not, let us know and we'll walk you through the process!

Best
Wolfgang

[Jean-Paul Pelteret]

Hi Vachan,

To supplement the link that Wolfgang shared, there’s also a detailed step-by-step guide for contributing patches to the library that can be found on our Wiki page:

https://github.com/dealii/dealii/wiki/Contributing

Looking forward to your contribution!

Jean-Paul

--
The deal.II project is located at http://www.dealii.org/
For mailing list/forum options, see https://groups.google.com/d/forum/dealii?hl=en
--- You received this message because you are subscribed to the Google Groups "deal.II User Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dealii+un...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/dealii/6b3ba865-88ea-11fb-cf3b-1b47ae9f876c%40colostate.edu.

[vachanpo...@gmail.com]

Dr. Wolfgang and Dr. Jean-Paul,

Thank you for the links. I noticed that the documentation of collect_periodic_faces() has already been fixed. I have created pr11990 for subdivided_hyper_cube().

[Wolfgang Bangerth]

> Thank you for the links. I noticed that the documentation of
> collect_periodic_faces()

> <https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.dealii.org%2Fcurrent%2Fdoxygen%2Fdeal.II%2FnamespaceGridTools.html%23ab22eef800535f9e85a1723a6a36fd0f6&data=04%7C01%7CWolfgang.Bangerth%40colostate.edu%7C1b2036afb6404d5a635a08d8f4187f8f%7Cafb58802ff7a4bb1ab21367ff2ecfc8b%7C0%7C0%7C637527733349420033%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=9hhVDLEDczxyg%2Bb2CNzKegvfuzYCxfxFQjlPXMgFYnk%3D&reserved=0> has
> already been fixed.

Yes, Daniel was too fast :-)


> I have created pr11990
> <https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fdealii%2Fdealii%2Fpull%2F11990&data=04%7C01%7CWolfgang.Bangerth%40colostate.edu%7C1b2036afb6404d5a635a08d8f4187f8f%7Cafb58802ff7a4bb1ab21367ff2ecfc8b%7C0%7C0%7C637527733349430035%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=daqvsP93OLcqDImAQGF564rLMxEBi8EeVaUAINI3%2F74%3D&reserved=0>
> for subdivided_hyper_cube()
> <https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.dealii.org%2Fcurrent%2Fdoxygen%2Fdeal.II%2FnamespaceGridGenerator.html%23a358d5bd545bc115c8645d93fa79b64bc&data=04%7C01%7CWolfgang.Bangerth%40colostate.edu%7C1b2036afb6404d5a635a08d8f4187f8f%7Cafb58802ff7a4bb1ab21367ff2ecfc8b%7C0%7C0%7C637527733349430035%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=6OPFkoGPW4g6UorOE3Rt5wEg7mxhK7DqsdLYtE6w9OE%3D&reserved=0>.

Most excellent! Welcome to the list of deal.II authors!