This offering is not approved or endorsed by ESI-OpenCFD® or the OpenFOAM® Foundation, the producer of the OpenFOAM® software and owner of the OpenFOAM® and OpenCFD® trademarks.

The CoCoons Project Community-driven Documentation on OpenFOAM® Technology

Holger Marschall [email protected]

The CoCoons Project • What does it stand for? CoCoons… • is about the C++ programming language for Computational Continuum Numerics and its main principles: object orientation (‚oo‘ in name), encapsulation (logo); code re-use, polymorphism and generic programming by inheritance and templated classes. • refers to self-contained ('encapsulated') documents embedded into an elaborated documentation framework – a modular approach to communitydriven documentation of the OpenFOAM® CFD Toolbox for Computational Continuum Mechanics.

Outline • What is it? What does the CoCoons Project do? • Who is it? Who works on the CoCoons Project? • How does it work? What is the conceptual approach of the CoCoons Project? • Why should I contribute? What are the incentives for companies and academia? • Quo vadis? Future Plans … A personal note …

What is it? • What does the CoCoons Project do? The CoCoons Guides to OpenFOAM® Technology • CoCoons Utility Guide to OpenFOAM® Technology • CoCoons Modelling Guide to OpenFOAM® Technology

top-level (first step!)

• CoCoons Solvers Guide to OpenFOAM® Technology Scope of the CoCoons Project •

Free high-quality documentation on OpenFOAM® Technology – Correct & accurate – Consistent & coherent – Structured & readable

What is it? • What does the CoCoons Project do? LaTeX templates for professional typesetting • Technical accurate documentation on OpenFOAM® Technology • Own CoCoons class (style) and macros for LaTeX Project Website • Joomla-based, providing a professional content management system (CMS) All available under

www.cocoons-project.org

What is it? • What does the CoCoons Project do? Professional Publishing… • Two partners standing side by side with the CoCoons Project: Partner Publishing House – Open Source Press As CoCoons Guides have substantially grown in content from community-driven contributions and reach adequate coverage of OpenFOAM® technology, they will be made available and published as book with ISBN. Note: All rights stay with the authors. (License: GNU FDL)

What is it? • What does the CoCoons Project do? Professional Publishing… • Two partners standing side by side with the CoCoons Project: Partner Journal – Computer Physics Communication CPC welcomes Computational Physics (CP) papers which utilize the OpenFOAM® CFD library and address models, numerical methods and algorithms in the physical sciences. Note: - CPC Program Library (Code release along with publications!) - Computer Programs in Physics (CPiP) papers allow publication of established methods/algorithms/models

Who is it? • Who works on the CoCoons Project? • OpenFOAM® community (companies, consultancies and academia), contributing as CoCoons Author or Reviewer • Community of FOAMers from all over the world • The CoCoons Project Core Group – CoCoons Reviewer (peer review & technical review) – CoCoons Documentation Maintenance (markup & typesetting)

How does it work? • What is the conceptual approach of the CoCoons Project? • Contribute as CoCoons Author – Upload form for submission of CoCoons documentation after review.

• Contribute as CoCoons Reviewer – Registration form for notification about new documents that need review. To join simply fill in the forms under

www. cocoons-project.org

How does it work? • What is the conceptual approach of the CoCoons Project? •

CoCoons Project’s Quality Assessment Procedure: CoCoons contributions undergo a review process … – Peer Review clarity and overall flow, conciseness, usefulness – Technical Review correctness and technical clarity, completeness

How does it work? • What is the conceptual approach of the CoCoons Project? •

State of CoCoons Contributions: Monitoring the Documentation Progress… (avoid repetitive work) – Documents under Progress – Documents under Review – Documents need Review Add ‚_forReview‘ to file name at submission

Why should I contribute? • What are the incentives for contributions? Academia • Your work (and expertise) becomes utmost visible and professionally published via the CoCoons Project Partners. • You contribute into a documentation system which is maintained and inherently involves a peer and technical review process (visually high quality, consistent and clear appearance throughout, precise and concise technical writing). • The CoCoons Project combines and pools the knowledge of the community into a centralized collection of free high quality documentation: (i) FOAM community benefits as a whole. (ii) Sustainability is of major interest to all of us. • The rights (and freedom) stay with the CoCoons authors: you may publish any of the CoCoons documents, including your own, and even get monetary benefits. Companies & Consultancies

Why should I contribute? • What are the incentives for contributions? Academia • Your work (and expertise) becomes utmost visible and professionally published via the CoCoons Project Partners. ionmaintained and inherently • You contribute into a documentation system which atis t n e cum(visually o d involves a peer and technical review process SS)!high quality, consistent n O e ( v t i i pir concise S ty-drprecise i e n and clear appearance throughout, and c u r load technical writing). u m n o m w S o o n C d ythe peand l n O o • The CoCoons Project combines e pools knowledge of the community into t ! e in th e do no t u b ntri documentation: (i) FOAM community as high tquality a centralized collection of o c Plefree bu benefits as a whole. (ii) Sustainability is of major interest to all of us. • The rights (and freedom) stay with the CoCoons authors: you may publish any of the CoCoons documents, including your own, and even get monetary benefits. Companies & Consultancies

Why should I contribute? • What are the incentives for contributions? Companies & Consultancies • the same as for academia • In addition, the following might be interesting: – mentioning within the chapter appendix: this means a short portfolio (companies) and short CVs of author and reviewer (academia). – a banner (company logo) can be added to the downloadable chapter (pdf and LaTeX source) increasing visibility and stressing expertise (planned).

Why should I contribute? • What are the incentives for contributions? Companies & Consultancies • the same as for academia • In addition, the following might be interesting: – mentioning within the chapter appendix: this means a short portfolio (companies) and short CVs of author and reviewer (academia). iple: CFS)! c n i r  (F er p torvthe d h – a banner (company logo) can t ps) chapter (pdf and LaTeX be added downloadable e o u n k a e o s o - expertise o h (planned). source) increasing visibility ande,stressing  first ue, n

-com redit is d t s r i F re c e h w it (cred

Legal Notes • The CoCoons Project License CoCoons Project‘s License Terms (based on GFDL, affirmed by FSF) • All CoCoons Documentation is licensed under the GNU Free Documentation License 1.3; License model is affirmed by the Free Software Foundation, Inc. • Further requirements are: – License the derivative work with the same license (The GNU Free Documentation License 1.3). – Include an appropriate copyright notice and at least a pointer to this license. – Give due credit to previous authors and major contributors.

• It is further requested that – all derivative work is sent to the CoCoons Project. – all modifications are noted & the person making the modifications is identified. –…

Legal Notes • Usage of the name ‘CoCoons’ and OpenFOAM® cocoon® is a registered trademark of the Apache Server Foundation (ASF) • Yes, but … … the above use has been officially approved by ASF within the scope of scientific computing.  OpenFOAM® is a registered trademark of ESI® group • Well, yes but … … the usage of the trademarked wording is purely referential or descriptive. Appropriate disclaimers have been added to avoid confusion of potential customers of ESI-OpenCFD® about the origin or source of OpenFOAM® goods and services (which is ESI-OpenCFD®).

Closing… Further plans • CoCoons Quick Getting Started Guide to OpenFOAM® Technology • CoCoons Quick Reference Guide to OpenFOAM® Technology (online) • „Winter of Documentation“

Contact

Holger Marschall [email protected]

Closing… Personal Note…  Sustainability should be a major concern of all of us!  Think about a contribution! Any contribution is valuable and highly appreciated.  I will need help for maintaining this!  Any help is welcome: please let me know if you are willing to help out with a part in the workflow!

Closing… Thanks for your attention … … Keep FOAMing and Contribute!

Contact

Holger Marschall [email protected]