قراردادهای تایپی

قراردادهای تایپی

قراردادهای تایپی
تمام اسناد از مجموعه‌ای از قراردادهای چاپی منسجم استفاده می‌کنند که پیگیری بحث را آسان‌تر می‌کند، درک آنچه را که می‌توانید در رابط کاربری گرافیکی (GUI) ببینید، و می‌دانید کدام داده‌ها باید در فیلدهای مختلف ورودی داده وارد شوند.
به طور خاص، از این قراردادها در سراسر مستندات استفاده می شود:
 
قرارداد
مثال
متن با رنگ آبی برجسته شده است
برای رفتن به اطلاعات دیگر در PDF، روی متن مشخص شده با رنگ آبی کلیک کنید. هنگامی که از میز کمک در COMSOL استفاده می کنید، پیوندها به ماژول های دیگر، نمونه های برنامه کاربردی و مجموعه های مستندات نیز کار می کنند.
فونت پررنگ
یک قلم پررنگ نشان می دهد که کلمه(های) داده شده دقیقاً به همین شکل در دسکتاپ COMSOL (یا برای دکمه های نوار ابزار، در راهنمای ابزار مربوطه) ظاهر می شود. به عنوان مثال، اغلب به پنجره Model Builder اشاره می شود و این پنجره ای است که شامل درخت مدل است. به عنوان مثالی دیگر، ممکن است دستورالعمل ها بگویند که روی دکمه بزرگنمایی  ( ) کلیک کنید، و این بدان معناست که وقتی با ماوس خود روی دکمه می روید، همان برچسب روی دسکتاپ COMSOL نمایش داده می شود.
فونت مورب
فونت ایتالیک معرفی اصطلاحات مهمی است. انتظار داشته باشید که توضیحی را در همان پاراگراف یا در واژه نامه پیدا کنید. نام سایر اسناد موجود در مجموعه مستندات COMSOL نیز با فونت مورب است.
نماد فلش رو به جلو >
نماد فلش رو به جلو > به این معنی است که شما مجموعه ای از آیتم های منو یا گره ها را به ترتیب خاصی انتخاب می کنید. برای مثال، Component>Mesh معادل است با: در زیر گره Component ، روی گره Mesh کلیک کنید .
فونت کد (مینی ون).
فونت کد ( تک فضا) به این معنی است که شما یک ورودی صفحه کلید در دسکتاپ COMSOL ایجاد می کنید. ممکن است دستورالعملی مانند «در قسمت چگالی جریان ، 1.25 را وارد کنید (یا تایپ کنید) ببینید. فونت monospace نیز برای نشان دادن کد برنامه نویسی و نام متغیرها استفاده می شود.
فونت کد کج (تک فضا).
فونت کد مورب (تک فضا) ورودی‌های کاربر و بخش‌هایی از نام‌ها را نشان می‌دهد که می‌توانند متفاوت باشند یا توسط کاربر تعریف شوند.
براکت های پیکان <> زیر فونت های کد (تک فضا) یا کد (مورب).
برای مثال، براکت‌های پیکانی که در نمونه‌های برنامه‌نویسی گنجانده شده‌اند (پس از کد تک‌فضا یا فونت کد مورب ) به این معناست که محتوای رشته می‌تواند آزادانه توسط کاربر انتخاب یا وارد شود، مانند نام ویژگی یا برچسب. برای مثال model.geom( <label> ) که در آن <label> برچسب هندسه است.
هنگامی که رشته توسط COMSOL Multiphysics از پیش تعریف شده است، هیچ براکتی استفاده نمی شود و این نشان می دهد که این یک مجموعه محدود است، مانند یک نوع ویژگی.
کلید گرافیک
در سراسر مستندات، از نمادها برای کمک به سازماندهی اطلاعات استفاده می شود. این آیکون ها از نظر اهمیت متفاوت هستند، اما توصیه می شود این کادرهای متنی را مطالعه کنید.
 
آیکون
نام
شرح
احتیاط
نماد احتیاط نشان می دهد که کاربر باید با دقت پیش رفته و مراحل بعدی را در نظر بگیرد. ممکن است به این معنی باشد که یک عمل مورد نیاز است، یا اگر دستورالعمل ها رعایت نشود، مشکلاتی در راه حل مدل وجود خواهد داشت.
مهم
نماد مهم نشان می دهد که اطلاعات ارائه شده کلید ساختمان، طراحی یا راه حل مدل است. اطلاعات از اهمیت بالاتری نسبت به یادداشت یا نکته برخوردار است و کاربر باید سعی کند دستورالعمل ها را دنبال کند.
توجه داشته باشید
یک نماد یادداشت نشان می دهد که اطلاعات می تواند برای کاربر مفید باشد. توصیه می شود کاربر متن را مطالعه کند.
نکته
نماد نکته برای ارائه اطلاعات، یادآوری‌ها، میانبرها، پیشنهادهایی برای بهبود طراحی مدل و سایر اطلاعاتی که ممکن است مفید باشد استفاده می‌شود.
همچنین ببینید
نماد See Also نشان می دهد که سایر اطلاعات مفید در قسمت نامگذاری شده قرار دارند. اگر آنلاین کار می کنید، روی لینک کلیک کنید تا مستقیماً به اطلاعات بروید. هنگامی که پیوند خارج از سند PDF فعلی است، متن این را نشان می دهد، به عنوان مثال، ” رابط جریان آرام را در کتابچه راهنمای مرجع Multiphysics COMSOL ببینید.” توجه داشته باشید که اگر در راهنمای آنلاین هستید، پیوند کار می کند.
نمونه ای از کتابخانه های کاربردی
این نماد در مستندات برای نشان دادن نمونه هایی استفاده می شود که استفاده از برخی عملکردها را نشان می دهد. در برخی موارد، یک نمونه تنها در صورتی در دسترس است که مجوز یک ماژول خاص را داشته باشید. مسیر Application Library نحوه یافتن فایل واقعی در COMSOL Multiphysics را توضیح می دهد، به عنوان مثال:
اگر ماژول RF دارید، به بخش رادار مراجعه کنید : مسیر کتابخانه برنامه RF_Module/Scattering_and_RCS/radar_cross_section
ابعاد فضایی
مجموعه دیگری از نمادها در Model Builder استفاده می شود – بعد فضای مؤلفه با تقارن محوری 1  بعدی ، تقارن محوری 2 بعدی، تقارن محوری 2 بعدی  و نمادهای سه بعدی نشان داده می شود. نمادهای 1D و 0D استفاده نمی شوند اما بعد فضا نشان داده شده است. این نمادها همچنین در اسناد برای فهرست کردن تفاوت‌های یک رابط فیزیک، گره یا بخش تئوری استفاده می‌شوند که بر اساس بعد فضا هستند.
پنجره ها
این نماد به این معنی است که اطلاعات مربوط به سیستم عامل مایکروسافت ویندوز است.
سیستم عامل مک
این نماد به این معنی است که اطلاعات مربوط به سیستم عامل macOS است. هنگام توضیح نحوه دسترسی به یک ویژگی یا منو در دسکتاپ COMSOL، ممکن است به آن به عنوان کراس پلتفرم نیز اشاره شود.
لینوکس
این نماد به این معنی است که اطلاعات مربوط به یک سیستم عامل لینوکس است. هنگام توضیح نحوه دسترسی به یک ویژگی یا منو در دسکتاپ COMSOL، ممکن است به آن به عنوان کراس پلتفرم نیز اشاره شود.